http

[HTTP]#6 HTTP API 설계 예시

쁘띠뀨띠 2023. 12. 6. 18:15

1_HTTP API - POST 기반 등록 (예: 회원 관리 API 제공)

- 클라이언트는 등록될 리소스의 URI를 모른다.(POST /members)

- 서버가 새로 등록된 리소스 URI를 생성한다. (HTTP/1.1 201 Created // Location: /members/100)

- Collection : 서버가 관리하는 리소스 디렉토리 *여기서 컬렉션은 /members

 

     회원 목록 /members → GET

     회원 등록 /members → POST

     회원 조회 /members/{id} → GET

     회원 수정 /members/{id} → PATCH, PUT, POST

     회원 삭제 /members/{id} → DELETE

 

2_HTTP API - PUT 기반 등록 (예: 정적 컨텐츠 관리, 원겨 파일 관리)

- 클라이언트가 리소스 URI를 알고 있어야 한다. (예: /files/star.jpg)

- 클라이언트가 직접 리소스의 URI를 지정

- Store : 클라이언트가 관리하는 리소스 저장소 *여기서 스토어는 /files

 

     파일 목록 /files → GET

     파일 등록 /files/{filename} → PUT

     파일 조회 /files/{filename} → GET

     파일 삭제 /files/{filename} → DELETE

     파일 대량 등록 /files POST

 

3_HTML FORM - GET / POST만 지원 (예: 웹 페이지 회원 관리)

- 컨트롤 URI : 동사로 된 리소스 경로 사용 (예: /new, /edit, /delete), HTTP 메소드로 해결하기 애매한 경우

 

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