HTTP API설계 예시

1. POST를 이용한 신규 자원 등록

 

1) 클라이언트는 등록될 리소스의 URI를 모름

- 회원등록: /members -> POST

  예) POST /members

 

2) 서버가 새로 등록된 리소스 URI를 생성해 줌

예) HTTP/1.1 201 Created

  Location: /members/100  

 

3) 컬렉션(Collection)

- 서버가 관리하는 리소스 디렉토리

- 서버가 리소스의 URI를 생성하고 관리

- 위 예시에서 컬렉션은 /members

 

 

2. PUT을 이용한 신규 자원 등록

 

1) 클라이언트가 리소스 URI를 알고 있어야 함.

- 파일등록: /files/{filename} -> PUT

  예) PUT /files/star.jpg

 

2) 클라이언트가 직접 리소스의 URI를 지정함

 

3) 스토어(Store)

- 클라이언트가 관리하는 리소스 저장소

- 클라이언트가 리소스 URI를 알고 관리

- 위 예시에서 스토어는 /files 

 

 

3. HTML FORM 사용

- 순수 HTML, HTML FORM은 GET, POST만 지원하므로 제약이 있음

- AJAX 같은 기술을 사용해서 해결 가능

- 컨트롤 URI

  GET, POST만 지원하므로 이런 제약을 해결하기 위해 동사로 된 리소스 경로 사용

  POST로 보내지만 /new, /edit, /delete 같은 컨트롤 URI를 사용

  HTTP 메서드로 해결하기 애매한 경우 사용(HTTP API 포함)