HTTP API 설계 예시

회원 관리 시스템

API 설계 - POST 기반 등록

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

API 설계 - PUT 기반 등록

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

HTML FORM 사용

• HTML FORM은 GET,POST만 지원
• AJAX 같은 기술을 사용해서 해결 가능
• 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

• 컨트롤 URI
  • GET, POSt만 지원하므로 제약이 있다.
  • 이런 제약을 해결하기 위해 동사로 된 리소스 경로를 사용한다.
  • POST의 /new, /edit, /delete가 컨트롤 URI
  • HTTP 메소드로 해결하기 애매한 경우에 사용한다.