RESTful API를 위한 6가지 원칙과 네이밍

RESTful API Naming

URI 는 Resource 만 식별

  1. 리소스를 표한하기 위해 명사를 사용하라
    1. 문서
    2. 컬렉션
    3. 스토어
    4. 컨트롤 URI 혹은 컨트롤러
  2. 일관성이 핵심이다
    1. 계층 관계표현을 위해 / 를 사용하라
    2. 마지막 문자로 / 를 사용하지 마라
    3. 가독성을 위해 - 를 사용하라
    4. _언더스코어는 사용하지마라
    5. 소문자를 사용하라
    6. 파일 확장자를 사용하지 마라
  3. crud 함수명 사용하지마라
  4. 필터를 위해 쿼리 파라미터를 사용해