HTTP API 설계 예시

1. HTTP API - 컬렉션

   • POST 기반 등록
   • 예) 회원 관리 API 제공

2. HTTP API - 스토어

   • PUT 기반 등록
   • 예) 정적 컨텐츠 관리, 원격 파일 관리

3. HTML FORM 사용

   • 웹 페이지 회원 관리
   • GET, POST만 지원

3가지 예시가 있는데 대부분 3가지 안에 들어갑니다.

HTTP API를 사용하는데 회원 관리용 API를 개발해야 한다고 가정하겠습니다. 그럴 때 URI와 GET, POST, PUT, DELETE를 어떻게 써야하는지 알아보겠습니다.

HTTP API를 쓰는데 첫 번째는 POST로 등록하는 기능, 두 번째는 PUT 기반으로 등록하는 기능을 알아보겠습니다.

POST도 데이터를 등록할 때 쓸 수 있고, PUT도 새로운 데이터를 등록할 때 쓸 수 있습니다. 이 두개를 활용할 때 약간 다른 특징이 있습니다.

이것을 정리하는게 엄청 중요합니다. 그래서 이것을 정리할 것 입니다.

그리고 HTML FORM은 GET과 POST만 사용 가능한데, 이러한 제약이 있는데 어떻게 설계하는지 알아보겠습니다.

HTTP API - 컬렉션

1. 회원 관리 시스템 API 설계 - POST 기반 등록

제일 먼저 회원 관리 시스템을 만들어야 한다고 생각해봅시다.

URI는 항상 리소스를 식별해야지 리소스가 아닌 다른 것을 식별하면 안됩니다.

즉, 미네랄이 리소스이고 캐는 것은 리소스가 아닙니다. "캐다, 조회하다" 같은 것들은 GET, POST, DELETE 같은 HTTP 메서드를 사용하면 됩니다.

POST 기반으로 등록하면 아래 처럼 URI를 설계하면 됩니다.

• 회원 목록 /members → GET
  • member에 대한 데이터를 json으로 쭉 내려주면 됩니다. member가 10개면 10개에 대한 데이터를 내려주면 됩니다.
  • 만약 회원이 100만개면 회원을 검색할 수 있는 검색어가 들어가야합니다. 그럼 검색어를 쿼리 파라미터로 넣도록 설계하면 됩니다. 마찬가지로 정렬 조건도 쿼리 파라미터에 넣도록 설계를 하면 됩니다.
• 회원 등록 /members → POST
  • /members를 컬렉션이라고 부릅니다. 밑에서 자세하게 설명합니다.
  • 컬렉션(회원을 관리하는 URI)에다가 뭔가 데이터를 넣으면 새로 등록 되도록 약속을 하는 것 입니다.
• 회원 조회 /members/{id} → GET
  • 회원을 조회하는 것은 컬렉션 아래에다가 하위에 있는 id 하나만 넣어주면 됩니다.
  • URI는 계층적 구조로 설계가 되기 때문에 사람이 이해하기 편합니다.