HTTP API 설계

HTTP API 설계

HTTP API - 컬렉션

• POST 기반 등록
  • 회원 목록 /members -> GET
  • 회원 등록 /members -> POST
  • 회원 조회 /members/{id} -> GET
  • 회원 수정 /members/{id} -> PATCH, PUT, POST
  • 회원 삭제 /members/{id} -> DELETE

클라이언트는 등록될 리소스의 URI를 알지 못한다. URI는 서버가 생성 및 관리하며 Location 헤더 필드에 담아서 응답한다.

HTTP API - 스토어

• PUT 기반 등록
  • 파일 목록 /files -> GET
  • 파일 조회 /files/{filename} -> GET
  • 파일 등록 /files/{filename} -> PUT
  • 파일 삭제 /files/{filename} -> DELETE
  • 파일 대량 등록 /files -> POST

클라이언트가 직접 리소스의 URI를 지정하므로 클라이언트가 리소스 URI를 알고 있어야 한다. URI는 클라이언트가 생성 및 관리한다.

HTML FORM 사용

• HTML FORM은 GET, POST만 지원한다.
  • 회원 목록 /members -> GET
  • 회원 등록 폼 /members/new -> GET
  • 회원 등록 /members/new, /members -> POST
  • 회원 조회 /members/{id} -> GET
  • 회원 수정 폼 /members/{id}/edit -> GET
  • 회원 수정 /members/{id}/edit, /members/{id} -> POST
  • 회원 삭제 /members/{id}/delete -> POST

GET, POST만 지원하므로 제약이 있다. 이를 해결하기 위해 동사로 된 리소스 경로를 사용한다.
여기서는 POST의 /new, /edit, /delete가 컨트롤 URI(동사 포함)이다.

참고 문서 및 링크

• 모든 개발자를 위한 HTTP 웹 기본 지식