API URI 설계
- 회원 조회 /read-member-by-id
- 회원 등록 /create-member
- 회원 수정 /update-member
- 회원 삭제 /delete-member
위의 설계는 좋은 URI 설계가 아니다. URI 설계에서 중요한 것은 리소스 식별이다.
리소스란?
- 회원의 등록, 수정, 조회하는 것이 아닌 회원이라는 개념 자체가 리소스다.
- 회원 등록, 수정, 조회는 모두 배제하고 회원이라는 리소스만 식별하여 URI에 매핑하면 된다.
API URI 설계 (리소스 식별, URI 계층 구조 활용)
- 회원 목록 조회 /members
- 회원 조회 /members/{id}
- 회원 등록 /members/{id}
- 회원 수정 /members/{id}
- 회원 삭제 /members/{id}
리소스와 행위를 분리
- URI는 리소스만 식별
- 리소스와 해당 리소스를 대상으로 하는 행위를 분리
- 리소스 : 회원
- 행위 : 조회, 등록, 수정, 삭제 (HTTP 메서드가 대신 해준다)
HTTP 메서드
- GET : 리소스 조회
- 서버에 전달하고 싶은 데이터는 쿼리 파라미터를 이용해 전달한다.
- POST : 요청 데이터 처리, 주로 등록에 사용
- 메시지 바디를 통해 서버로 요청 데이터 전달
- 서버는 요청 데이터를 처리
- 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
- 주로 전달된 데이터를 통해 신규 리소스 등록, 프로세스 처리에 사용한다.
1. 새 리소스 생성(등록)
2. 요청 데이터 처리
- POST의 결과로 새로운 리소스가 생성되지 않을 수 있다. 즉 프로세스 상태 변경이 있다면 POST를 사용한다.
- 리소스만으로 URI를 다 설계할 수 없기 때문에 최대한 리소스만을 이용하되 필요하다면 컨트롤 URI를 사용하자
- 예) POST /orders/{orderId}/start-delivery (컨트롤 URI)
3. 다른 메서드로 처리하기 애매한 경우
- PUT : 리소스를 대체, 해당 리소스가 없다면 생성
- (*중요) 클라이언트가 리소스를 식별한다.
- 클라이언트가 리소스 위치를 알고 URI를 지정하는게 POST와 차이점이다.
- 만약 username="jun", age=50 이라는 리소스를 age=20 이라는 리소스로 대체하면 username 필드는 삭제되고 age=20 만 있는 리소스로 대체된다
- PATCH : 리소스 부분 변경
- 만약 username="jun", age=50 이라는 리소스를 age=20이라는 리소스로 대체하면 username"jun", age=20으로 변경된다.
- 대부분 되는데 PATCH를 못 쓸 경우가 있다. 이런 경우에는 POST를 쓰면 된다.
- DELETE : 리소스 삭제
- 기타 메서드 : HEAD, OPTION, CONNECT, TRACE
HTTP 메서드의 속성
안전(Safe Methods)
- 호출해도 리소스를 변경하지 않는다. (GET,HEAD)
멱등(Idempotent Methods)
- 한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다.
- 첫 행위와 다음 행위들의 결과만 같으면 멱등이다.
- 외부 요인으로 변경되어 결과가 달라지는 경우는 고려하지 않는다.
- ex) get을 계속 호출하던 와중에 put 등으로 결과가 바뀌면 get의 결과도 바뀌게 됨.
- GET, PUT, DELETE / POST는 멱등이 아니다.
- 서버가 정상 응답을 주지 못 했을 때, 클라이언트가 다시 요청을 해도 되는가에 대한 판단 기준
캐시가능(Cacheable Methods)
- 응답 결과 리소스를 캐시해서 사용해도 되는가?
- GET, HEAD, POST, PATCH 캐시 가능
- 실제로는 GET, HEAD 정도만 캐시로 사용
- POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않다.
'HTTP' 카테고리의 다른 글
HTTP 상태코드 (0) | 2024.09.12 |
---|---|
HTTP 메서드 활용 (0) | 2024.09.09 |
HTTP 기본 (3) | 2024.09.04 |
웹 브라우저 요청 흐름 (0) | 2024.05.15 |
URI (0) | 2024.05.15 |