HTTP API 설계 예시

파일 관리 시스템

• 파일 목록 -> GET
• 파일 조회 -> GET
• 파일 등록 -> PUT
• 파일 삭제 -> DELETE
• 파일 대량 등록 -> POST

HTTP API - 컬렉션

• Post 기반 등록
• 예) 회원 관리, API 제공

1. POST 등록 (대부분 사용)

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

HTTP API - 스토어

• PUT 기반 등록
• 예) 정적 컨텐츠 관리, 원격 파일 관리

1. PUT등록

• /files/{filename} ->PUT
  • 클라이언트가 직접 리소스의 URI를 지정한다.
  • 스토어
    • 클라이언트가 관리하는 리소스 저장소
    • 클라이언트가 리소스의 URI를 알고 관리
    • 여기서 스토어는 "/files"

HTML Form

• 웹 페이지 회원 관리
• GET, POST만 지원하므로 제약이있음
• AJAX 같은 기술을 사용해서 해결가능

컨트롤 URI (컨트롤러)

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

정리

• HTTP API - 컬렉션
  • POST 기반 등록
  • 서버가 리소스 URI 결정
• HTTP API - 스토어
  • PUT 기반 등록
  • 클라이언트가 리소스 URI 결정
• HTML FORM 사용
  • 순수 HTML + HTML Form 사용
  • GET, POST만 지원