HTTP API 설계 가이드 라인

API 설계 - POST 기반 등록

-회원 관리 시스템-  

 

-회원 목록 /members  -> get

-회원 등록 /members -> post

-회원 조회 /members/{id} -> get

-회원 수정 /members/{id} ->patch,put,post

-회원 삭제 /members/{id} -> delete

 

post - 신규 자원 등록 특징

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

 1) 회원 등록 /members -> post

 2) post /members

 

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

 -> HTTP/1.1 201 Created

     Location: /members/100

 

- 컬렉션(Collection)

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

 2) 서버가 리소스의 uri를 생성하고 관리

 3) 여기서 컬레션은 /members

 

API 설계 - PUT 기반 등록

 

- 파일 목록 /files -> get

- 파일 검색 /files/{filename} ->get

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

- 파일 삭제 /files/{filename} -> delete

- 파일 대량등록 /files -> post

 

put - 신규 자원 등록 특징

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

 1) 파일등록 /files/{filename} ->put

 2) put /files/star.jpg

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

- 스토어 (store)

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

 2) 클라이언트가 리소스의 uri를 알고 관리

 3) 여기서 스토어는 /files

 

HTML FORM 사용

-회원 목록 /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 사용

• HTML FORM은 GET, POST만 지원 •

컨트롤 URI • GET, POST만 지원하므로 제약이 있음

•이런 제약을 해결하기 위해 동사로 된 리소스 경로 사용

• POST의 /new, /edit, /delete가 컨트롤 URI

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

• 문서(document)

• 단일 개념(파일 하나, 객체 인스턴스, 데이터베이스 row)

• 예) /members/100, /files/star.jpg

 

• 컬렉션(collection)

• 서버가 관리하는 리소스 디렉터리

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

• 예) /members

 

•스토어(store)

• 클라이언트가 관리하는 자원 저장소

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

• 예) /files

 

• 컨트롤러(controller), 컨트롤 URI

• 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행

• 동사를 직접 사용

• 예) /members/{id}/delete

 

참고 https://restfulapi.net/resource-naming/

REST Resource Naming Guide

출처: 김영한의 http-웹-네트워크