HTTP API 설계 예시

1. HTPT API - 컬렉션 POST 기반 등록, 서버가 리소스 URI 결정 ex) 회원 관리 API 제공

2. HTTP API - 스토어 PUT 기반 등록, 클라이언트가 리소스 URI 결정 ex) 정적 컨텐츠 관리, 원격 파일 관리

3. HTML FORM 사용 GET, POST만 지원❤️⭐️, 순수 HTML + HTML form 사용 ex) 웹 페이지 회원 관리

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

• 회원 목록 /members -> GET

• 회원 등록 /members -> POST

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

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

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

POST -신규자원등록 특징

• 클라이언트는 등록될 리소스의 URI를 모른다. 회원 등록/members -> POST POST/members

• 서버가 새로 등록된 리소스 URI를 생성해준다. HTTP/1.1 201 Created
 Location: /members/100

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

파일 관리 시스템 API 설계 - PUT 기반 등록

• 파일 목록 /files -> GET

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

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

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

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

PUT -신규자원등록특징

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

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

• 스토어(Store)

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

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

• 여기서 스토어는 /files

HTML FORM 사용

• GET, POST만 지원

• AJAX 같은 기술을 사용해서 해결 가능 -> 회원 API 참고

• 여기서는 순수 HTML, HTML FORM 이야기

• GET, POST만 지원하므로 제약이 있음 : HTTP 메서드로 해결하기 애매한 경우 사용(HTTP API 포함) =>컨트롤 URI 등장! 동사로 된 리소스 경로 사용 ex) POST의 /new, /edit, /delete가 컨트롤 URI

• 회원 목록 : /members -> GET

• 회원 등록 폼 : /members/new -> GET

• 회원 등록 : /members/new, /members -> POST

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

• 회원 수정 폼 : /members/{id}/edit -> GET 회원 수정 폼을 전송할 때는 POST를 사용하지만 회원 수정 폼 그 자체만 들어가는 경우 조회이므로 GET 사용!

• 회원 수정 : /members/{id}/edit, /members/{id} -> POST

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

참고하면 좋은 URI 설계 개념 최대한 리소스로 URI 설계하고(문서, 컬렉션, 스토어), 리소스와 HTTP 메서드만으로 안되는 경우 컨트롤 URI를 사용한다!

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

2. 컬렉션(collection) 서버가 관리하는 리소스 디렉터리 서버가 리소스의 URI를 생성하고 관리 ex) /members

3. 스토어(store) 클라이언트가 관리하는 자원 저장소 클라이언트가 리소스의 URI를 알고 관리 ex) /files

4. 컨트롤러(controller), 컨트롤 URI 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행 동사를 직접 사용 ex) /members/{id}/delete