HTTP API 설계 예시

강한친구·2022년 4월 7일
0

Server Studies

목록 보기
22/27

HTTP API - 컬렉션

회원관리 시스템

POST 기반 등록

회원관리 시스템 개발
• 회원 목록 /members -> GET
• 회원 등록 /members -> POST
• 회원 조회 /members/{id} -> GET
• 회원 수정 /members/{id} -> PATCH, PUT, POST
• 회원 삭제 /members/{id} -> DELETE

특이사항

  • 클라이언트는 등록될 리소스의 URI를 모른다.
  • 서버가 새로 등록된 리소스 URI를 생성한다
  • Collection
    • 서버가 관리하는 리소스 디렉토리
    • 서버가 URI를 생성하고 관리
    • 컬렉션 리소스는 /members

파일 관리 시스템

PUT 기반 등록

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

특이사항
PUT으로 신규자원을 등록한다.

  • 클라이언트가 리소스 URI를 알아야한다.
    • PUT/files/abc/jpg
  • 클라이언트가 생성될 URI를 알고, 이걸 클라이언트가 관리한다
  • 스토어(Store)
    • 클라이언트가 관리하는 리소스 저장소
    • 클라이언트가 리소스의 URI를 알고 관리
    • 여기서 스토어는 /files

HTML FORM

폼은 기본적으로 GET, POST만 지원한다.
이전글의 API처럼 AJAX같은 기술로 해결이 가능함

• 회원 목록 /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

특이사항

  • HTML FORM은 GET. POST만 사용한다
  • 제약이 있어서 동사로 된 리소스를 사용한다.
  • 삭제의 경우, DELETE를 쓸 수 없으니 Control URI를 도입해서 해결해야한다
  • Control URI 라고 한다.
    • Control URI는 꼭 FORM이 아니더라도 종종 사용된다.

정리

HTTP API - 컬렉션

• POST 기반 등록
• 서버가 리소스 URI 결정

HTTP API - 스토어

• PUT 기반 등록
• 클라이언트가 리소스 URI 결정

HTML FORM 사용

• 순수 HTML + HTML form 사용
• GET, POST만 지원

참고자료

0개의 댓글