HTTP 활용 - HTTP API 설계 예시

API 설계 - post 기반 등록

회원 목록  /members GET

회원 등록 /members -> POST

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

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

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

 

post 기반 등록 특징

• 클라이언트는 등록될 리소스의 URI를 모른다.
• 회원 등록 /memebers ->POST
• 서버가 새로 등록된 리소스 URI를 생성해준다.
• 컬렉션
  • 서버가 관리하는 리소스 디렉토리
  • 서버가 리소스의 URI를 생성하고 관리

 

 

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를 알고 있어야한다.

 

 

API 설계 - HTMl FORM 사용

HTML FORM은 GET, POST만 지원

(AJAX 같은 기술을 사용하여 해결 가능 )

 

컨트롤 URI

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

 

회원 목록 /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 (DELETE 못)

 

 

참고하면 좋은 URI 설계 개념

문서(document)

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

- ex) /members/100, /files/star.jpg

 

컬렉션(collection)

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

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

- ex) /members

 

스토어(store)

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

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

- ex) /files

 

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

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

- 동사를 직접 사용

- ex) /members/{id}/delete

 

https://restfulapi.net/resource-naming

REST API - URL Naming Conventions