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
함께 읽은 게시물
디자인패턴, 리팩토링, 클린 아키텍처 등등의 책들은 전공서적 보듯이 보는게 아니라 추리소설 보듯이 보는 것임. 이런 책은 추리소설처럼 일부 논리적으로 사고 할 수 있는 능력을 길러주긴 하지만, 기본적으로는 재미로 보는 것임. 경험적인 정보이지 과학적인 지식이 아님을 명심해야 함.
최근에 코딩 IDE와 AI 에이전트들이 우후죽순 출시되면서, AI에게 프로젝트에 대한 중요한 정보와 규칙들을 알려주기 위한 방식들도 난립하고 있었는데요. 이것들이 이제 AGENTS.md 로 통일될 것 같습니다.
... 더 보기
사이드 프로젝트, 진짜 재미는 후반전에 있다
며칠 전, 우아한형제들 임동준 님의 유튜브 영상을 보다 마음에 들어오는 메시지를 들었다. 영상은 AI에 대한 이야기였지만, 그 과정에서 나온 이 조언이 더 깊게 남았다.
... 더 보기넷플릭스는 왜 WebFlux를 사용하지 않을까?
십
... 더 보기뭐든간에 처음 셋팅하는 것이 제일 힘들다. 어려운 것보다는 귀찮은 일 투성이. 하지만 시작이 있어야 결과도 있는 법이니. 마침내 결과가 좋기만을 바랄 뿐. 💪🦾
