[HTTP] HTTP API 설계 예시 | 회원 관리 HTTP API 예제

 

 

 

HTTP API 설계 방법은 크게 3가지로 나눌 수 있다.

 

 

 

• HTTP API - 컬렉션

  - POST 기반 등록

  - 예) 회원 관리 API 제공

 

 

• HTTP API - 스토어

  - PUT 기반 등록

  - 예) 정적 컨텐츠 관리, 원격 파일 관리

 

 

• HTML FORM 사용

  - 웹 페이지 회원 관리

  - GET, POST만 지원

 

 

 

 

 

 

 

 

● HTTP API - 컬렉션(POST 기반 등록)

 

 

 

POST 기반 등록 API 설계를 해보자.

 

 

 

Ex) 회원 관리 시스템

 

 

• 회원 목록 /members -> GET

• 회원 등록 /members -> POST

• 회원 조회 /members/{id} -> GET

• 회원 수정 /members/{id} -> PATCH, PUT, POST

• 회원 삭제 /members/{id} -> DELETE

 

 

 

일반적으로 HTTP API를 설계할 때는 위와 같이 리소스(Ex. 회원(members))를 기준으로

HTTP 메소드를 부여하도록 하는 방식(REST)으로 설계를 해야한다.

 

 

POST 기반으로 신규 자원 등록시 아래와 같은 특징이 있다.

 

 

• 클라이언트는 등록될 리소스의 URI를 모른다.

  - 회원 등록 /members -> POST

  - POST /members

 

• 서버가 새로 등록된 리소스 URI를 생성해준다.

  - HTTP/1.1 201 Created Location: /members/100

 

 

 

 

이렇게 신규 자원 등록 시 서버가 리소스 URI를 알고있는 방식을 컬렉션이라고 한다.

 

 

 

• 컬렉션(Collection)

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

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

  - 여기서 컬렉션은 /members

 

 

 

 

 

 

---

● HTTP API - 스토어(PUT 기반 등록)

 

 

 

PUT 기반 등록 API 설계를 해보자.

 

 

Ex) 파일 관리 시스템

 

 

• 파일 목록 /files -> GET

• 파일 조회 /files/{filename} -> GET

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

• 파일 삭제 /files/{filename} -> DELETE

• 파일 대량 등록 /files -> POST

 

 

 

 

PUT 기반으로 신규 자원 등록시 아래와 같은 특징이 있다.

 

 

• 클라이언트가 리소스 URI를 알고 있어야 한다.

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

  - PUT /files/star.jpg

 

• 클라이언트가 직접 리소스의 URI를 지정한다.

 

 

 

이렇게 신규 자원 등록 시 클라이언트가 리소스 URI를 알고 저장하는 방식을 스토어 라고한다.

 

 

 

• 스토어(Store)

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

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

  - 여기서 스토어는 /files

 

 

 

 

 

 

---

● HTML FORM 사용

 

 

 

HTML FORM은 GET, POST만 지원한다.

 

물론 AJAX 같은 기술을 사용해서 PUT, DELETE 등의 메소드를 사용할 수 있지만,

순수 HTML, HTML FORM을 사용시에는 GET, POST만 지원하므로 몇가지 제약이 있다.

 

 

HTML FORM 사용 API 설계를 해보자.

 

 

 

Ex) 회원 관리 시스템

 

 

• 회원 목록 /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만 지원하므로

이런 문제를 해결하기 위해 동사로 된 리소스 경로를 지정하는

컨트롤 URI를 사용한다.

 

위 예시에서 보이는 POST의 /new, /edit, /delete가 컨트롤 URI이다.

HTTP 메서드로 해결하기 애매한 경우에 사용된다.