[HTTP 웹 기본 지식] HTTP 메서드 활용 - HTTP API 설계 예시

🌱 HTTP API 설계 예시

API 설계 - POST 기반 등록

👉 회원 관리 시스템
     1. 회원 목록: /members ➡️ GET
     2. 회원 등록: /members ➡️ POST
     3. 회원 조회: /members/{id} ➡️ GET
     4. 회원 수정: /members/{id} ➡️ PATCH, PUT, POST
     5. 회원 삭제: /members/{id} ➡️ DELETE

 

신규 자원 등록 특징

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

 

API 설계 - PUT 기반 등록

👉 파일 관리 시스템
     1. 파일 목록: /files ➡️ GET
     2. 파일 조회: /files/{filename} ➡️ GET
     3. 파일 등록: /files/{filename} ➡️ PUT
     4. 파일 삭제: /files/{filename} ➡️ DELETE
     5. 파일 대량 등록: /files ➡️ POST

 

신규 자원 등록 특징

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

 

HTML Form 사용

👉 회원 관리 시스템
     1. 회원 목록: /members ➡️ GET
     2. 회원 등록 폼: /members/new ➡️ GET
     3. 회원 등록: /members/new, /members ➡️ POST
     4. 회원 조회: /members/{id} ➡️ GET
     5. 회원 수정 폼: /members/{id}/edit ➡️ GET
     6. 회원 수정: /members/{id}/edit, /members/{id} ➡️ POST
     7. 회원 삭제: /members/{id}/delete ➡️ POST

 

• 순수한 HTML과 HTML Form은 GET, POST만 지원하기 때문에 제약이 있다.
• 컨트롤 URI
  • GET, POST만 지원하는 제약을 해결하기 위해 동사로 된 리소스 경로를 사용
  • HTTP 메서드로 해결하기 애매한 경우 사용
  • 👉 /members/new
  • 👉 /members/{id}/edit
  • 👉 /members/{id}/delete

 

📚 참고하면 좋은 URI 설계 개념

• 문서(document) : 단일 개념 (파일 하나, 객체 인스턴스, 데이터베이스 row)
  
  • 👉 /members/100 /files/star.jpg
• 컬렉션(Collection) : 서버가 관리하는 리소스 디렉토리
  • 클라이언트는 요청만 하고 서버가 리소스의 URI를 생성하고 관리한다.
  • 👉 /members
• 스토어(Store) : 클라이언트가 관리하는 자원 저장소
  • 클라이언트가 리소스의 URI를 알고 관리한다.
  • 👉 /files
• 컨트롤러(Controller), 컨트롤 URI : 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행할 때 동사를 직접 사용한다.
  • 👉 /members/{id}/delete