HTML

# 8 HTTP API 설계 예시

오늘의 진 2022. 8. 21. 21:35
HTTP APT -컬렉션 HTTP API - 스토어 HTML FORM 사용
POST 기반등록
예) 회원관리 API 제공
PUT 기반등록
예)  정적 컨텐츠 관리, 원격 파일 관리
웹 페이지 회원 관리 
GET, POST만 지원 

 

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

회원목록 / members  ->GET
회원 등록/members  ->POST
회원조회 /members / {id} ->GET
회원 수정 / members / {id } ->PATCH, PUT, POST
회원 삭제 / members /{id}  ->DELETE

회원 관리 시스템 

POST - 신규 자원 등록 특징 

1.클라이언트는 등록될 리소스의 URI를 모른다 (서버가 부여함)

-회원등록 :   POST/members

2.서버가 새로 등록된 리소스의 URI 생성 

-HTTP/1.1 201 Created

Location : / members/100

3. 컬렉션(Collection)

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

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

-여기서 컬렉션은 /members

 

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

파일목록/filse -> GET
파일조회 / filse/{filename} -> GET
파일등록 /files /{filename} -> PUT
파일삭제 / files/{filename} ->DELETE
파일대량등록 /files -> POST

 

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

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

-PUT/files/star.jpg

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

3.스토어 (Store)

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

-클라이언트가 리소스의 URI를 알고 관리 -여기서 스토어는 /files