HTTP API 설계 예시

회원 관리 시스템

• 회원 목록 /members → GET
• 회원 등록 /members → POST
• 회원 조회 /members/{id} → GET
• 회원 수정 /members/{id} → PATCH, PUT, POST
  • 앞서 배웠다싶이 PUT 완전히 교체를 해버리는데 회원정보수정을 PUT으로 처리하면 클라이언트에서 모든정보를 한번에 완전히 보내야한다.. 누락시 데이터 전체가 날라가기 때문에 주로 PATCH로 처리한다.
  • 게시글의 경우 PUT을 사용할 수 있다.
  • 상황이 애매하면 그냥 POST로 쓰기도 한다.
• 회원 삭제 /members/{Id} → DELETE

HTTP API - 컬렉션

POST - 신규 자원 등록 특징

• 클라이언트는 등록될 리소스의 URI를 모른다. (POST, PUT의 큰 차이)
  • 클라이언트는 서버에게 요청만 한다 서버에서 알아서 URI 리소스를 만들어서 내려준다.
  • 회원등록 /members →POST
  • POST /members
• 서버가 새로 등록된 리소스 URI를 생성해준다.
  • HTTP/1.1
• 컬렉션
  • 서버가 관리하는 리소스 디렉토리
  • 서버가 리소스의 URI를 생성하고 관리
  • 여기서 컬렉션은 /members

파일 관리 시스템

• 파일 목록 /files → GET
• 파일 조회 /files/{filename} → GET
• 파일 등록 /files/{filename} → PUT
  • PUT 특성: DB에 없으면 새로 만들어주고 있다면 PUT으로 들어온 데이터 덮어씀 개별파일 등록에 아주 적절한 매서드
• 파일 삭제 /files/{filename} → DELETE
• 파일 대량 등록 /files → POST

HTTP API - 스토어

PUT - 신규 자원 등록 특징

• 클라이언트가 리소스 URI를 알고 있어야 한다.
  • 파일 등록 /files/{filename} → PUT
  • PUT /files/star.jpg >> 클라이언트가 알고 등록한다
• 클라이언트가 직접 리소스의 URI를 지정한다.
• 스토어
  • 클라이언트가 관리하는 리소스 저장소
  • 클라이언트가 리소스의 URI를 알고 관리한다.
  • 여기서 스토어는 /files

HTML FORM 사용

• HTML FORM은 GET, POST만 지원
• AJAX 같은 기술을 사용해서 해결가능 > 위에 회원 API
• 여기서는 순수 HTML, HTML FORM
• GET, POST만 지원하므로 제약있음

• 제약이 있기 때문에
• 컨트롤 URI 실무에서 정말 많이쓴다.
  • 제약을 해결하기 위해 동사로 된 리소스 경로 사용
  • POST의 /new, /edit, /delete가 컨트롤 URI
  • HTTP 매서드로 해결하기 애매한 경우 사용한다.(HTTP API포함)

좋은 URI 설계 개념

문서

• 단일 개념(파일 하나, 객체 인스턴스, 데이터베이스 row)
• /mebers/100, /files/star.jpg

컬렉션

• 서버가 관리하는 리소스 디렉터리
• 서버가 리소스의 URI를 생성하고 관리
• /members

스토어

• 클라이언트가 관리하는 리소스 저장소
• 클라이언트가 리소스의 URI를 알고 관리한다.
• files , 게시판 정도

컨트롤러

• 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행
• 동사를 직접 사용한다
• /members/{id}/delete

정리

우선 최대한 리소스(명사, 미네랄)로 리소스를 설계한다.

해결이 안되는 상황에만 컨트롤러 URI로 해결한다.