[RESTFUL API] URI 설계 개념

문서(Document)

- 단일개념(파일 하나, 객체 인스턴스, 데이터베이스 row)

- 즉, 리소스 하나에 접근할때 쓰는주소

- 클라이언트가 /member로 회원정보를 던져주면 서버가 db에 저장하면서 id=100같은 pk를 생성하고, 그걸 응답으로 알려줌

  post로 보내면 서버가 URI 만듦 (응답헤더 location부분에 리소스 붙여서 보냄)

ex) /members/100

      /files/star.jpg

 

컬렉션(Collection)

- 서버가 관리하는 리소스의 집합 (디렉터리)

- 여러 문서들이 모여있는 상위 개념

- 서버가 리소스의 URI를 생성하고 관리

ex) /members

 

스토어(Store)

- 클라이언트가 관리하는 자원 저장소

- 클라이언트가 리소스의 URI를 알고 관리

- 서버보다는 클라이언트가 어떤 URI가 있는지 알고있음

ex) /files

 

컨트롤러(Controller), 컨트롤 URI

- 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행

- REST원칙에선 URI는 명사로 표현하는게 이상적이지만, 어쩔수없이 동사를 쓸때가 있음

  (즉, 추가동작(프로세스)를 URI로 드러내는 케이스)

- 동사를 직접 사용

ex) /members/{id}/delete

     /orders/{id}/cancel

 

반응형

 

 

 

https://restfulapi.net/resource-naming

REST API URI Naming Conventions and Best Practices