REST API 설계 시 URL 네이밍 규칙

Question

REST API를 설계하는데 URL을 어떻게 만들어야 하나요? 네이밍 규칙이 있나요?

김영삼 · Accepted Answer

REST API URL 설계 원칙:# GOOD ✅ GET /api/users # 사용자 목록 GET /api/users/123 # 특정 사용자 POST /api/users # 사용자 생성 PUT /api/users/123 # 사용자 수정 DELETE /api/users/123 # 사용자 삭제 # 하위 리소스 GET /api/users/123/posts # 사용자의 게시글 GET /api/users/123/posts/456 # 특정 게시글 # 필터/정렬/페이징 GET /api/posts?category=tech&sort=latest&page=2&limit=20 # BAD ❌ GET /api/getUsers POST /api/createUser GET /api/user/delete/123규칙:명사 사용 (동사 X)복수형 사용 (/users, /posts)소문자 + 하이픈 (/user-profiles)HTTP 메서드로 행위 구분버전 관리: /api/v1/users

댓글 1