HTTP API 설계 예시

bird.j·2021년 5월 24일
0

HTTP

목록 보기
6/7

💡 HTTP API - 스토어


  • PUT 기반 등록
    • PUT으로 신규 리소스 등록 --> 클라이언트가 리소스의 URI를 알고있다.(알고있어야한다.)
  • 클라이언트가 리소스의 URI를 결정, 관리



💡 HTTP API - 컬렉션


  • POST기반 등록
    • 클라이언트는 등록될 리소스의 URI를 모른다.
  • 서버가 리소스의 URI 결정
    • 서버가 새로 등록된 리소스 URI를 생성해준다.

따라서 신규로 자원을 등록할 때는 POST를 많이 쓴다.



💡 HTML FORM - GET, POST만 가능


  • 이러한 제약을 해결하기 위해 동사로 된 리소스 경로 사용
  • POST의 /new, /edit, /delete 등이 컨트롤 URI
    • HTTP 메서드로 해결하기 애매한 경우 사용(HTTP API 포함)
    • 컨트롤 URI는 동사를 사용



💡 참고하면 좋은 URI 설계 개념


https://restfulapi.net/resource-naming

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

0개의 댓글