HTTP 설계 예시

HTTP API - 컬렉션
 - POST 기반 등록
 - 예) 회원 관리 API 제공
HTTP API - 스토어
 - PUT 기반 등록
 - 예) 정적 컨텐츠 관리, 원격 파일 관리
HTML FORM 사용
 - 웹 페이지 회원 관리
 - GET, POST만 지원

메서드를 배우기 이전에 API를 설계하기에 URL만으론 식별하기가 어렵다는 것을 기억하고 있을 것이다
메소드를 배운 이후엔 아래와 같이 식별할 수 있게 된다
- 회원 목록 /members -> GET
- 회원 등록 /members -> POST
- 회원 조회 /members/{id} -> GET
- 회원 수정 /members/{id} -> PATCH, PUT, POST
- 회원 삭제 /members/{id} -> DELETE

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

PUT기반 API 설계 (스토어)
- 파일 목록 /files -> GET
- 파일 조회 /files/{filename} -> GET
- 파일 등록 /files{filename} -> PUT // 이미 파일이 있다면 덮어씌우는게 옳다고 가정
- 파일 삭제 /files/{filename} -> DELETE
- 파일 대량 등록 /files > POST // 임의로 /files의 POST를 이와같이 저장

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

대부분 POST를 사용하고, PUT기반은 매우 드물다


HTML FORM 사용
- HTML FORM은 GET, POST만 지원
- AJAX 같은 기술을 사용해서 해결 가능 > 회원 API 참고
  여기서는 순수 HTML, HTML FORM 이야기

HTML FORM 으로 API를 설계하면 이렇게 된다
- 회원 목록 /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 메서드로 해결하기 애매한 경우 사용(HTTP API 포함)


참고하면 좋은 URI 설계 개념
문서(document) 
- 단일 개념(파일 하나, 객체 인스턴스, 데이터베이스 row)
- 예) /members/100, /files/star.jpg
 컬렉션(collection) 
- 서버가 관리하는 리소스 디렉터리
- 서버가 리소스의 URI를 생성하고 관리
- 예) /members
스토어(store) 
- 클라이언트가 관리하는 자원 저장소
- 클라이언트가 리소스의 URI를 알고 관리
- 예) /files
컨트롤러(controller), 컨트롤 URI 
- 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행
- 동사를 직접 사용
- 예) /members/{id}/delete

정리
URI를 설계하게 된다면, 가장 먼저 리소스 만으로 최대한 설계하자
/members/{id} ... 같은 리소스만으로 해결이 안되는 경우에는
(컬렉션과 문서만으로 GET, POST, PUT, DELETE를 사용하여 최대한 해결을 한다)
컨트롤 URI 를 사용하면 된다