[22/05/09] HTTP 메서드 활용 - API 설계 예시

Que Lin·2022년 5월 9일

김영한님 http웹 기본지식

목록 보기

6/13

왠만하면 patch 게시물 수정같은 경우 put

HTTP API 설계 예시(2가지)

컬렉션
• POST 기반 등록
• 예) 회원 관리 API 제공
• 대부분 실무에서 많이 사용
스토어
• PUT 기반 등록
• 예) 정적 컨텐츠 관리, 원격 파일 관리
HTML FORM 사용
• 웹 페이지 회원 관리
• GET, POST만 지원
• AJAX 같은 기술을 사용해서 해결 가능 -> 회원 API 참고
• 여기서는 순수 HTML, HTML FORM 이야기
• GET, POST만 지원하므로 제약이 있음

회원 관리 시스템

API 설계 - POST 기반 등록
• 회원 목록 /members -> GET
• 회원 등록 /members -> POST
• 회원 조회 /members/{id} -> GET
• 회원 수정 /members/{id} -> PATCH, PUT, POST
• 회원 삭제 /members/{id} -> DELETE

파일 관리 시스템

API 설계 - PUT 기반 등록
• 파일 목록 /files -> GET
• 파일 조회 /files/{filename} -> GET
• 파일 등록 /files/{filename} -> PUT
• 파일 삭제 /files/{filename} -> DELETE
• 파일 대량 등록 /files -> POST

신규 자원 등록 특징(새로운 데이터)

POST

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

PUT

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

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(제약이 있기때문에 어쩔 수 없이 uri 경로에 행위까지 표시함)

컨트롤 URI란?

• HTML FORM은 GET, POST만 지원하므로 제약이 있음
• 이런 제약을 해결하기 위해 동사로 된 리소스 경로 사용
• POST의 /new, /edit, /delete가 컨트롤 URI
• HTTP 메서드로 해결하기 애매한 경우 사용(HTTP API 포함)
• 어쩔 수 없이 실무에서 사용함 -> 최대한 자원만을 표시하고 어쩔 수 없을 때 대체제로써 활용(동사로 사용)

정리

참고하면 좋은 URI 설계 개념

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