REST API 설계 시 URL 네이밍 컨벤션 질문

Question

REST API를 처음 설계하고 있는데 URL 네이밍을 어떻게 해야 할지 모르겠습니다.

# 어떤 게 맞는 건가요?
GET /getUsers       vs  GET /users
GET /user/1         vs  GET /users/1
POST /createUser    vs  POST /users
GET /users/search?q=kim  vs  GET /search/users?q=kim

복수형을 써야 하는지, 동사를 URL에 넣어도 되는지, 중첩 리소스는 어디까지 깊이 들어가야 하는지 기준이 궁금합니다.

김영삼 · Accepted Answer

REST API 네이밍에는 업계에서 널리 쓰이는 컨벤션이 있습니다. 핵심 원칙: # 1. 명사 복수형 사용 (동사 X) GET /users # 목록 조회 GET /users/1 # 단건 조회 POST /users # 생성 PUT /users/1 # 전체 수정 PATCH /users/1 # 부분 수정 DELETE /users/1 # 삭제 # 2. 중첩은 2단계까지만 GET /users/1/posts # OK GET /users/1/posts/5/comments # 너무 깊음 GET /posts/5/comments # 이렇게 분리 # 3. 필터/검색은 쿼리 파라미터 GET /users?role=admin&sort=name GET /users?q=kim # 4. kebab-case 사용 GET /user-profiles (O) GET /userProfiles (X) GET /user_profiles (X) URL에는 동사를 넣지 않습니다. HTTP 메서드(GET, POST, PUT, DE

댓글 4