HTTP API 설계 (PUT, POST)

회원 관리 시스템

API 설계 - post 기반 등록

 

회원 목록 /members ->GET

회원 등록 /members -> POST

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

회원 수정 /members/{id} -> PATCH(부분수정), PUT(전체수정), POST

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

 

 

POST - 신규 자원 등록 특징

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

- 회원등록 /members ->POST

- POST /members

 

- 서버가 새로 등록된 리소스 URI를 생성해준다

- 컬렉션 (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 사용

HMTL FORM은 GET, POST만 지원(순수한 html form)

AJAX 같은 기술을 사용해서 해결 가능

• 회원 목록 /members -> GET
• 회원 등록 폼 /members/new -> GET
• 회원 등록 /members/new, /members -> POST
• 회원 조회 /membrs/{id} -> GET
• 회원 수정 폼 /members/{id}/edit -> GET
• 회원 수정 /members/{id}/edit, /members/{id} -> POST
• 회원 삭제 /members/{id}/delete -> POST (delete 라는 메서드를 쓸 수 없기 때문에 어쩔 수 없이 POST로 사용하고, /delete라는 컨트롤 URI를 사용해야함.)

폼이랑 수정이랑 URI를 맞추는걸 선호.(다시 redirect 하기 편하기 때문에)

HTML FORM 사용

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

 

 

참고하면 좋은 URI 설계 개념

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