1 소문자 사용
- 대문자X, 카멜X
2 슬래쉬(/) 사용
- 분류1/분류2 ...
- 분류1 범주에 분류2가 포함 혹은 큰 >>> 작은 범위
- http://api.example.com/animal/cats
3 하이픈 사용
- 동급의 단어 혹은 긴 단어
- http://api.example.com/my-post
- http://api.example.com/device-management/managed-devices
4 동사는 http method로 구분
- 필요시 동사 원형 사용
- GET /getUsers ===> GET /users
5 동일한 리소스를 타겟으로 하는 경우 api는 하나로 통일 권장
아래는 사용자 필터링 조회
/users/gender/female ===> /users?gender=female
6 명사는 복수 (단수냐 복수냐 의견이 분분함)
- http://api.example.com/users
- http://api.example.com/users/{userId}
- http://api.example.com/users/{userId}/wallets/{walletId}
POST /users
- 사용자 그룹에 사용자 추가(1명 이상)로도 해석 가능
- 여러명의 사용자를 추가한다고 해석 가능
[개인 의견]
- 단수 복수 혼용 X
- 복수 단수를 혼용하면 논리적으로 해석이 되나 헷갈림 => 통일
[참조]
Should I use Singular or Plural name convention for REST resources?
REST API 컨벤션 Top5! 단수, 복수, 네이밍 등의 url 설계를 위한 best practice 알아보기
7 Rules for REST API URI Design
REST Resource Naming Guide
