Best Practices for good REST API Design
Medium
🕊️ REST API 디자인을 위한 모범 사례
📌 JSON을 사용하라.
📌 URI Path에 동사 대신 명사를 사용하라.
www.api.example.com/v1/add_employees (X)
POST www.api.example.com/v1/employees (O)
📌 정확한 HTTP 상태 코드를 이용하여 응답을 구성하라.
📌 API 엔드포인트 보안
인증과 권한 부여 메커니즘을 포함하라.
📌 API 엔드포인트를 사용한 페이지네이션을 만들어라.
GET www.api.example.com/v1/employees?page_limit=250&page_index=1
📌 API 엔드포인트를 사용한 정렬을 허용하라.
GET www.api.example.com/v1/employees?sort=salary&sort_type=asc
📌 파라미터를 사용한 필터링을 허용하라.
GET www.api.example.com/v1/employees?id=3&isactive=true
📌 API 요청 수에 제한을 걸어라.
📌 API 버저닝
Version 1: www.api.example.com/v1/employees
Version 2: www.api.example.com/v2/employees
📌 API 문서를 작성하라.
다음 내용이 궁금하다면?
이미 회원이신가요?
2023년 3월 16일 오전 8:29
댓글 0
함께 읽은 게시물
< 모든 시도는 둘 중 하나다. 성공하거나 배우거나 >
1. 큰 수의 법칙. 시도가 많아질수록 결과는 평균에 수렴한다. 주사위를 많이 던질수록 각 숫자가 나오는 확률은 1/6에 가깝다.
똑똑하게 개발자 면접 준비하는 방법
처음 코딩 공부 시작할 때 아무도 이야기해주지 않았고 들어보지 못한 조언이지만, 꼭 미리 알아둬야 하는 팁입니다.
📌 영상 내용 정리
800건의 면접을 진행해 본 아마존 수석 엔지니어가 알려주는 똑똑하게 코딩 면접 준비하는 방법 (특히 시니어, 스태프, 수석 엔지니어에게 필요한 방법).
👇 자료 구조와 알고리즘 코딩 테스트 면접이 생긴 이유
실력 없는 개발자를 고용하면 회사에게 엄청난 기회비용이 발생한다. 하지만 실력 있은 개발자를 고용하면 반대로 엄청난 이득이다. 문제는 한 사람이 좋은 인재인지 아닌지... 더 보기
< 스포티파이와 멜론, 같은 음악인데 왜 경험은 다를까? >
1. 엔터테인먼트 프로덕트의 본질은 콘텐츠다. 사용자는 콘텐츠를 소비하며 감정을 느낀다. 재미, 감동, 공포, 희열. 인간의 다양한 감정이 콘텐츠를 통해 꺼내진다.
👋 LLM 활용에 도움이 되는 가이드 모음
✅️Prompting Guide 101 by Google : https://lnkd.in/d8UwPWeN
... 더 보기
