API 설계 가이드라인

REST 컨벤션

URL 설계

• 리소스는 복수형 명사: /users, /posts (동사 금지: /getUsers)
• 계층 관계는 중첩: /users/:id/posts
• 2단계 이상 중첩 금지 — 깊어지면 별도 리소스로 분리
• 쿼리 파라미터는 필터링/정렬/페이지네이션 용도: ?status=active&sort=createdAt

HTTP 메서드

• GET — 조회 (멱등, 부수 효과 없음)
• POST — 생성
• PATCH — 부분 수정 (PUT보다 PATCH 선호)
• DELETE — 삭제

상태 코드