Ch5.2 HTTP API 설계 예시

설계 예시

1. HTTP API - 컬렉션

• POST 기반 등록 ex) 회원 관리 API 제공

2. HTTP API - 스토어

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

3. HTML Form 사용

• 웹 페이지 회원 관리
• GET, POST만 지원 (순수 HTML에서)

대부분의 경우 3가지 예시 안에 들어간다.
POST와 PUT의 차이를 아는게 중요하다.

회원 관리 시스템

API 설계 - POST 기반 등록

• 회원 목록 /members -> GET
• 회원 등록 /members -> POST => 회원을 관리하는 URI = 컬렉션
• 회원 조회 /members/{id} -> GET
• 회원 수정 /members/{id} -> PATCH, PUT, POST
• 회원 삭제 /members/{id} -> DELETE

POST - 신규 자원 등록 특징

• 클라이언트는 등록될 리소스의 URI를 모른다.
  • 회원 등록 /members -> POST
  • POST /members
• 서버가 새로 등록된 리소스 URI를 생성해준다.
  • HTTP/1.1 201 CREATE
    Location: /members/100 -> 클라이언트는 id 100이라는 정보 전달하지 않음!
• 컬렉션(Collection)
  • 서버가 관리하는 리소스 디렉토리
  • 서버가 리소스의 URI를 생성하고 관리
  • 여기서 컬렉션은 /members

API 설계 - PUT 기반 등록

• 파일 목록 /files -> GET
• 파일 조회 /files/{filename} -> GET
• 파일 등록 /files/{filename} -> PUT
• 파일 삭제 /files/{filename} -> Delete
• 파일 대량 등록 /files -> POST -> 등록에 PUT 사용하므로 POST 행동 임의로 지정 가능

  PUT - 신규 자원 등록 특징

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

  거의 사용하지 않는다. 대부분 컬렉션 사용. 파일 업로드같은 특수한 경우만 사용

HTML FORM 사용

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

설계

• 회원 목록 /members -> GET
• 회원 등록 폼 /members/new -> GET
  • form Html을 받아온다
• 회원 등록 /members/new, /members -> POST
  • submit 했을 때, 둘 중 하나 선택
• 회원 조회 /members/{id} -> GET
  • 회원 상세 창 Html을 받아온다
• 회원 수정 폼 /members/{id}/edit -> GET
  • 수정 창 Html을 받아온다
• 회원 수정 /members/{id}/edit, /members/{id} -> POST
  • submit 했을 때, 둘 중 하나 선택
• 회원 삭제 /members/{id}/delete -> POST
  • delete라는 메서드를 사용할 수 없음 -> .../delete라는 컨트롤 URI 사용

컨트롤 URI

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

정리

참고하면 좋은 URI 설계 개념

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