HTTP API 설계 예시

회원 관리 시스템

⭐️ POST 기반 API 설계

• 회원 목록 : /members (GET)
• 회원 등록 : /members (POST)
• 회원 조회 : /members/{id} (GET)
• 회원 수정 : /members/{id} (PATCH, PUT, POST)
• 회원 삭제 : /members/{id} (DELETE)

POST 신규 리소스 등록 특징

• 클라이언트는 등록될 리소스의 URI를 모른다.
• 서버가 새로 등록된 리소스 URI를 생성해준다.
  • HTTP/1.1 201 Created
    Location: /members/100
• 컬렉선 (Collection)
  • 서버가 관리하는 리소스 디렉토리
  • 서버가 리소스의 URI를 생성하고 관리
  • 여기서 컬렉션은 /members

파일 관리 시스템

PUT 기반 API 설계

• 파일 목록 : /files (GET)
• 파일 조회 : /files/{filename} (GET)
• 파일 등록 : /files/{filename} (PUT)
• 파일 삭제 : /files/{filename} (DELETE)
• 파일 대량 등록 : /files (POST)

PUT 신규 자원 등록 특징

• 클라이언트가 리소스 URI를 알고 있어야 한다.
• 클라이언트가 직접 리소스의 URI를 지정한다.
• 스토어 (Store)
  • 클라이언트가 관리하는 리소스 저장소
  • 클라이언트가 리소스의 URI를 알고 관리
  • 여기서 스토어는 /files

📌 참고

실무에서는 POST기반의 컬렉션을 대부분 사용할 것이다. PUT은 잘 사용하지 않음

HTML FORM 사용

• HTML FORM은 GET, POST만 지원.
• AJAX 같은 기술을 사용해서 해결 가능.
• GET, POST만 지원하므로 제약이 있다.

• 회원 목록 : /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)

HTML FORM 특징

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

URI 설계 개념

문서 (document)

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

컬렉션 (collection)

• 서버가 관리하는 리소스 디렉터리
• 서버가 리소스의 URI를 생성하고 관리
• 대부분의 경우 컬렉션 사용

스토어 (store)

• 클라이언트가 관리하는 자원 저장소
• 클라이언트가 리소스의 URI를 알고 관리
• 가끔 파일이나 게시판에 스토어를 쓰기도 하는데 잘 쓰진 않는데. 대부분 컬렉션 사용

컨트롤러 (controller), 컨트롤 URI

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

참고 사이트

https://restfulapi.net/resource-naming