[Spring Boot] REST API naming 규칙

REST API naming 간단 정리

 

명사 사용

동사는 사용 X

GET /manage-order (X)
GET /order-management (O)

 

복수형 사용

GET /order (X)
GET /orders (O)

 

하위 리소스는 /를 이용하여 나타냄

PUT /users/{id}/orders

 

uri는 소문자 사용

GET /Users (X)
GET /users (O)

 

camelCase 대신 snake-case 사용

이때 _(underbar) 대신 -(hyphens) 사용한다는 것도 기억해두기

GET /orderManagement (X)
GET /order_management (X)
GET /order-management (O)