HTTP API 설계 예시

김원종·2023년 9월 19일

회원 관리 시스템 API 설계 - POST 기반 등록

회원 목록 /members -> GET
회원 등록 /members -> POST
회원 조회 /members/{id} -> GET
회원 수정 /members/{id} -> PATCH , PUT , POST
- PUT은 기존걸 덮어버린다. PATCH는 부분적으로 수정할수 있다.
  그래서 뭔가 회원의 정보를 수정할때는 PATCH로 하는게 제일 좋다 개념적으로 . 하 지만 데이터를 완전 덮어버려도 된다면 PUT을 사용해도 된다. 그렇지만 그런 경우는 없다고 생각하자 . 게시판 같은 경우는 부분수정하는 경우가 없기에 PUT을 사용하는 경우도 있다! 즉 데이터를 완전 덮어버려도 무방한경우 인것이다. 모든 경우가 애매하다면 무적의 POST로 사용하자!!
회원 삭제 /members{id} -> DELETE

회원 관리 시스템 POST 신규 자원 등록 특징
POST로 데이터 등록할때는 서버에서 보통 리소스 URI를 결정하고 만들어준다!

클라이언트는 등록될 리소스의 URI를 모른다.
- 회원 등록/members -> POST
- POST /members
서버가 새로 등록된 리소스 URI를 생성해준다.
- HTTP/1.1 201 Created Location: /members/100
컬렉션( Collection )
- 서버가 관리하는 리소스 디렉토리
- 서버가 리소스의 URI를 생성하고 관리
- 여기서 컬렉션은 /members

파일 관리 시스템 API 설계 - PUT 기반 등록

파일 관리 시스템 PUT 신규 자원 등록 특징
PUT로 등록할때는 리소스 URI를 다 알고 등록해야한다 그렇기에 클라이언트가 등록될 리소스의 URI를 직접 다 관리한다! 서버는 오는데로 해줄뿐!!이런 형태를 Sotre라고 한다.

클라이언트가 리소스 URI를 알고 있어야 한다.
- 파일 등록 /files/{filename} -> PUT
- PUT /files/star.jpg
클라이언트가 직접 리소스의 URI를 지정한다.
스토어(Store)
- 클라이언트가 관리하는 리소스 저장소
- 클라이언트가 리소스의 URI를 알고 관리
- 여기서 스토어는 /files

대부분 POST를 사용한다 PUT은 거의 사용하지 않는다

HTML FORM사용

HTML FORM은 GET,POST만 지원
컨트롤 URI
- GET, POST만 지원하므로 제약이 있음
- 이런 제약을 해결하기 위해 동사로 된 리소스 경로 사용
- POST의 /new ,/edit, /delete가 컨트롤 URI
- HTTP 메서드로 해결하기 애매한 경우 사용 ( HTTP API 포함 )

정리

참고하면 좋은 URI 설계 개념

김원종

개린이