[웹]HTTP API 설계 예시

HTTP API - 컬렉션

POST 기반 등록

• 클라이언트는 등록될 리소스의 URI를 모른다.
• 서버가 새롭게 등록될 리소스의 URI를 생성해줌.
• 컬렉션 (Collection)
  • 서버가 관리하는 리소스 디렉토리
  • 서버가 리소스의 URI를 생성하고 관리
  • 여기서 컬렉션은 /members
• 예) 회원 관리 API 제공
  • 회원 목록 /members → GET
  • 회원 등록 /members → POST
  • 회원 조회 /members/{id} → GET
  • 회원 수정 /members/{id} → PATCH(부분 수정), PUT(전체 수정), POST
  • 회원 삭제 /members/{id} → DELETE

HTTP API - 스토어

PUT 기반 등록

• 예) 정적 컨텐츠 관리, 원격 파일 관리
  • 파일 목록 /files → GET
  • 파일 조회 /files/{filename} → GET
  • 파일 등록 /files/{filename} → PUT (없으면 새로 생성, 있으면 덮어쓰기)
  • 파일 삭제 /files/{filename} → DELETE
  • 파일 대량 등록 /files → POST (files 경로를 임의로 지정한 것, 다른 역할로 써도 )
• PUT 신규 자원 등록 특징
  • 클라이언트가 리소스 URI를 알고 있어야 한다.
    • 파일 등록 /files/{filename} → PUT
    • PUT /files/star.jpg
  • 클라이언트가 직접 리소스의 URI를 지정한다.
  • 스토어(Store)
    • 클라이언트가 관리하는 리소스 저장소
    • 클라이언트가 리소스의 URI를 알고 관리한다
    • 여기서 스토어는 /files

대부분은 POST 기반의 컬렉션 사용

HTML FORM 사용

• 웹페이지 회원 관리
  • 회원 목록 /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
• GET, POST만 지원
• AJAX 같은 기술을 사용해서 해결 가능 → 회원 API 참고
• 여기서는 순수 HTML, HTML Form 이야기
• GET, POST만 지원하므로 제약이 있음
  • 컨트롤 URI 사용
    • 동사로 된 리소스 경로 사용
    • POST의 /new, /edit, /delete가 컨트롤 URI
    • HTTP 메소드로 해결하기 애매한 경우 사용(HTTP API 포함)
    • 최대한 사용하지 말고 진짜 어쩔 수 없을 때!

참고하면 좋은 URI 설계 개념

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