HTTP API 설계 예시

HTTP API 설계 예시를 살펴보자.

 

 

• HTTP API - 컬렉션
• POST 기반 등록
• 예) 회원 관리 API 제공

 

• HTTP API - 스토어
• PUT 기반 등록
• 예) 정적 컨텐츠 관리, 원격 파일 관리

 

• HTML FORM 사용
• 웹 페이지 회원 관리
• GET, POST만 지원

 

회원 관리 시스템을 만든다고 하자.

/ members는 collections라고 한다.

• 회원 목록 / members => GET
• 회원 등록 / members => POST
• 회원 조회 / members/{id} -> GET
• 회원 수정 / members/{id} -> PATCH, PUT, POST
• 회원 삭제 / members/{id} -> DELETE

 

POST -신규 자원 등록 특징

• 클라이언트는 등록될 리소스의 URI를 모른다.
• 회원 등록 / members -> POST
• POST / members
• 서버가 새로 등록된 리소스 URI를 생성해준다. => 굉장히 중요하다.
• HTPP/ 1.1 202 Created
• Location: /members/100

 

컬렉션(Collection)

• 서버가 관리하는 리소스 디렉토리
• 서버가 리소소의 URI를 생성하고 관리
• 여기서 컬렉션은 /members

 

이번에는 PUT 기반으로 파일 관리 시스템을 설계해보자. => 사용하는 빈도가 매우 낮다.

• 파일 목록 / files -> GET
• 파일 조회 / files/{filename} -> GET
• 파일 등록 / files/{filename} -> PUT
• 파일 삭제 / files/{filename} -> DELETE
• 파일 대량 등록 / files -> POST

 

 

스토어(Stroe)관리를 알아보자.

• 클라이언트가 리소스 URI를 알고 있어야 한다.
• 파일 등록 /files/{filename} -> PUT
• PUT / files/star.jpg

 

• 클라이언트가 직접 리소스의 URI를 지정한다.
• 스토어(Stroe)
• 클라이언트가 관리하는 리소스 저장소
• 클라이언트가 리소스의 URI를 알고 관리
• 여기서 스토어는 /files

 

HTML FORM 을 사용하는법을 보자.

• HTML FORM은 GET, POST만 지원한다.
• AJAX 같은 기술을 사용해서 해결이 가능하다. -> 회원 API 참고
• 여기서는 순수 HTML, HTML FORM 이야기
• GET, POST만 지원하므로 제약이 있다.

 

 

 

회원 삭제 경우는 delete라는 controller uri를 써야한다.(/new /edit도 마찬가지이다.) 

• 회원 목록 /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 => 무식하게 쓰지말자.(최대한 리소스의 개념을 알고 그 상황에서 해결할 수 없을 때 컨트롤 URI를 쓰자.)
• GET, POST만 지원하므로 제약이 있다.
• 이런 제약을 해결하기 위해 동사로 된 리소스 경로 사용
• POST의 / new, /edit, /delete가 컨트롤 URI
• HTTP 메서드로 해결하기 애매한 경우 사용(HTTP API 포함)

 

 

정리를 해보자

• HTTP API - 컬렉션
• POST 기반 등록
• 서버가 리소스 URI 결정

 

 

• HTTP API - 스토어
• PUT 기반 등록
• 클라이언트가 리소스 URI 결정

 

• HTML FORM 사용
• 순수 HTML + HTML form 사용
• GET, POST만 지원

 

restfulapi 참고 사이트도 보면서 스윽 정리해보자.

• 문서
• 단일 개념(파일 하나, 객체 인스턴스, 데이터베이스 row)
• 예) /members/100, /files/star.jpg

 

• 컬렉션
• 서버가 관리하는 리소스 디렉터리
• 서버가 리소스의 URI를 생성하고 관리
• 예) /members

 

• 스토어
• 클라이언트가 관리하는 자원 저장소
• 클라이언트가 리소스의 URI를 알고 관리
• 예) /files

 

• 컨트롤러(controller), 컨트롤 URI
• 문서 컬렉션 스토어로 해결하기 어려운 추가 프로세스 실행
• 데이터를 조작하거나 변경할 때 사용하므로 동사를 직접 사용한다.
• 예) /members/{id}/delete

 

결론은 이거다. 미네랄만 가지고 리소스를 설계한다. /members , /orders

이거 가지고 해결이 안되는 상황이면 컨트롤러 URI를 들어가면 된다.

 

컬렉션과 문서가지고 최대한 해결하고 POST GET PUT DELETE로 지지고 볶고 하다가 안되면

컨트롤 URI를 넣어서 해결하자.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

<출처 김영한: 모든 개발자를 위한 HTTP 웹 기본 지식 >

https://www.inflearn.com/course/http-%EC%9B%B9-%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC/dashboard

모든 개발자를 위한 HTTP 웹 기본 지식 - 인프런 | 강의