1. 복수

유저에 관한 로직을 수행하는 url의 경우 /user 혹은 /users처럼 작성할 수 있을 것입니다. 이 두개의 방법 중 복수형으로 작성하는 것이 권장됩니다. 즉 /users가 더 권장되는 방식입니다.

어떤 경우에는 단수형도 큰 문제가 없다고 말하긴 합니다. 하지만 중요한 점은 단수와 복수형을 중복하여 사용하지 않는다는 것입니다.

2. 명사

동사보다는 명사를 사용하는 것이 좋습니다. 동사를 사용하면 같은 리소스에 대한 동작도 경우에 따라서 이름이 매우 달라집니다. 하지만 명사를 사용하면 더 깔끔하게 api를 네이밍할 수 있습니다.

GET /getUsers ---> GET /users
POST /deleteUsers ---> POST /users

3. 하이픈(-)

공백은 밑줄(_) 대신에 하이픈(-)을 사용합니다.

4. 소문자

일반적으로 URI경로에서는 소문자를 사용합니다.

5. URL쿼리

필터링을 할 경우 새로운 api를 만들기 보다는 쿼리 파라미터를 활용하는 것이 선호됩니다.

/users/region/ko ---> /users?region=ko
/users/gender/female ---> /users?gender=female