HTTP API 설계 예시

• HTTP API - 컬렉션
  - POST 기반 등록
  - 회원 관리 API 제공
• HTTP API - 스토어
  - PUT 기반 등록
  - 정적 컨텐츠 관리, 원격 파일 관리
• HTML FORM 사용
  - 웹 페이지 회원 관리
  - GET, POST만 지원

 

1. 회원 관리 시스템

---

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

 

 

2. POST 기반 등록

---

• 클라이언트는 등록될 리소스의 URI를 몰라!!!!
  - 클라이언트는 데이터만 줌 ㅋㅋ
  - 회원 등록 / members -> POST
  - POST /members
• 서버가 새로 등록된 리소스 URI를 생성해줌.
  - HTTP/1.1 201 Created
    Location: /members/101
• Collection 스타일
  - 서버가 관리하는 리소스 디렉토리
  - 서버가 리소스의 URI를 생성하고 관리
  - 여기서 컬렉션은 /members

 

 

 

3. PUT 기반 등록

---

• 파일 목록 /files -> GET
• 파일 조회 /files/{filename} -> GET
• 파일 등록 /files/{filename} -> PUT
  - 클라이언트가 리소스의 URI를 알고 있어야함.
• 파일 삭제 /files/{filename} -> DELETE
• 파일 대량 등록 /files -> POST
• 클라이언트가 리소스 URI를 알고 있어야함.
  - PUT /files/star.jpg
• 클라이언트가 직접 리소스의 URI를 지정한다.
• Store 스타일
  - 클라이언트가 관리하는 리소스 저장소
  - 클라이언트가 리소스의 URI를 알고 관리함.
  - 여기서 스토어는 /files

 

 

4. HTML FORM 사용

---

• HTML FORM은 GET, POST만 지원
• AJAX 같은 기술을 사용해서 해결 가능
• 회원 목록 /members -> GET
• 회원 등록 폼 /members/new -> GET
• 회원 등록 /members/new, /members -> POST
• 회원 조회 /members/{id} -> GET
• 회원 수정 폼 /members/{id}/edit -> GET
• 회원 수정 /members/{id}/edit, /members/{id} -> PATCH, PUT, POST
• 회원 삭제 /members/{id}/delete -> POST : DELETE 메서드 못쓰니 control uri써야함.
• 컨트롤 URI
  - GET, POST만 지원하므로 제약이 있음
  - 이런 제약을 해결하기 위해 동사로 된 리소스 경로 사용
  - POST의 /new, /edit, /delete가 컨트롤 uri
  - HTTP 메서드로 해결하기 애매한 경우 사용(HTTP API 포함)

 

 

 

5. URI 설계 개념

---

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