개발

[요약] REST API 디자인 규칙 - 02. URI 식별자 설계

소년택이 2022. 4. 7. 01:30

URI 형태

  • 마지막 슬래시(/) 를 포함하지 않는다.
  • 가독성을 높이기 위해 하이픈(-)을 사용한다.
  • 밑줄(_)은 사용하지 않는다.
  • 소문자를 사용한다.
  • 확장자는 사용하지 않는다.

URI 경로

  • 도큐먼트 이름 - 단수 명사.
  • 컬렉션, 스토어 이름 - 복수 명사.
  • 컨트롤러 이름은 동사(구).
  • 변하는 부분은 유일한 값으로 대체.
  • CRUD 는 포함하지 않는다.