-
<모든 개발자를 위한 HTTP 웹 기본 지식>
HTTP API 설계 예시 (2가지 종류 있어! -> POST, PUT)
- HTTP API - 컬렉션
- POST 기반 등록
- 예) 회원 관리 API 제공
- HTTP API - 스토어
- PUT 기반 등록
- 예) 정적 컨텐츠 관리, 원격 파일 관리
- HTML FORM 사용
- 웹 페이지 회원 관리
- GET, POST만 지원
자 [ 회원 관리 시스템 ] 을 만든다고 생각해봐
URI(리소스)를 식별하는건 -> 항상 리소스를 식별해야지 다른걸 식별하면 안돼!
- 회원 목록 /members -> GET
- 회원 등록 /members -> POST
- 회원 조회 /members/{id} -> GET
- 회원 수정 /members/{id} -> PATCH, PUT, POST (PATCH : 부분적으로 수정) (PUT : 완전히 덮기) (POST : 애매할땐 POST)
- 회원 삭제 /members/{id} -> DELETE
[POST]
- 리소스 등록 1 : 메시지 전달 (클라이언트 -> 서버) /members 에 신규 데이터를 등록할거야! 서버에 요청!
- 리소스 등록 2 : 신규 리소스 생성 (서버 -> 디비에 저장, 신규 리소스 식별자 생성 하고 /members/100-> 클라이언트에 응답)
회원 관리 시스템 POST - 신규 자원 등록 특징
- 클라이언트는 등록될 리소스의 URI를 모른다.
- 회원 등록 /members -> POST
- POST /members
- 서버가 새로 등록된 리소스 URI를 생성해준다.
- HTTP/1.1 201 Created
Location: /members/100
- 컬렉션(Collection) : 이런 형식을 말함!
- 서버가 관리하는 리소스 디렉토리
- 서버가 리소스의 URI를 생성하고 관리
- 여기서 컬렉션은 /members
파일 관리 시스템 API 설계 - PUT 기반 등록
- 파일 목록 /files -> GET
- 파일 조회 /files/{filename} -> GET
- 파일 등록 /files/{filename} -> PUT (기존 파일 지우고 다시 설정해야하니깐 PUT!)
- 파일 삭제 /files/{filename} -> DELETE
- 파일 대량 등록 /files -> POST
파일 관리 시스템 PUT - 신규 자원 등록 특징
- 클라이언트가 리소스 URI를 알고 있어야 한다.
- 파일 등록 /files/{filename} -> PUT
- PUT /files/star.jpg
- 클라이언트가 직접 리소스의 URI를 지정한다.
- 스토어(Store)
- 클라이언트가 관리하는 리소스 저장소
- 클라이언트가 리소스의 URI를 알고 관리
- 여기서 스토어는 /files
HTML FORM 사용
- 회원 목록 /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 사용
- HTML FORM은 GET, POST만 지원
- 컨트롤 URI
- GET, POST만 지원하므로 제약이 있음
- 이런 제약을 해결하기 위해 동사로 된 리소스 경로 사용
- POST의 /new, /edit, /delete가 컨트롤 URI
- HTTP 메서드로 해결하기 애매한 경우 사용(HTTP API 포함)