HTTP API 설계 예시

HUSII·2023년 1월 19일
0
  1. HTTP API 컬렉션
  2. HTTP API 스토어
  3. HTML FORM 사용

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

클라이언트는 등록될 리소스의 URI를 모른다.
서버가 새로 등록된 리소스 URI를 생성해준다.

컬렉션: /members


HTTP API 스토어
PUT 기반 등록
• 파일 목록 /files -> GET
• 파일 조회 /files/{filename} -> GET
• 파일 등록 /files/{filename} -> PUT
• 파일 삭제 /files/{filename} -> DELETE
• 파일 대량 등록 /files -> POST
클라이언트가 리소스 URI를 알고 있어야 한다.
클라이언트가 직접 리소스의 URI를 지정한다.

스토어: /files


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

동사를 직접 사용

profile
공부하다가 생긴 궁금한 것들을 정리하는 공간

0개의 댓글