1. HTTP API 만들기
HTTP API를 만들 때, 요구사항을 식별하고 그에 맞는 URI를 설계하는 것이 필요하다.
다음 예시로 그 과정을 들어보겠다.
요구사항 - API URI 설계 (1)
| 기능 | URI |
|---|---|
| 회원 목록 조회 | /read-member-list |
| 회원 조회 | /read-member-by-id |
| 회원 등록 | /create-member |
| 회원 수정 | /update-member |
| 회원 삭제 | /delete-member |
이게 정말 좋은 URI일까?
URI 설계에서 가장 중요한 것은 리소스 식별이다.
API URI 고민사항
- 리소스의 의미
회원을 등록하고 수정하고 조회하는게 리소스가 아니다!
ex) 미네랄을 캐라! -> 미네랄이 리소스
회원이라는 개념 자체가 바로 리소스다.- 리소스 식별 방법
회원을 등록하고 수정하고 조회하는 것을 모두 배제
회원이라는 리소스만 식별하면 된다 -> 회원 리소스를 URI에 매핑
요구사항 - API URI 설계 (2)
| 기능 | URI |
|---|---|
| 회원 목록 조회 | /members |
| 회원 조회 | /members/{id} |
| 회원 등록 | /members/{id} |
| 회원 수정 | /members/{id} |
| 회원 삭제 | /members/{id} |
리소스 식별 중심으로 URI 설계를 했다.
그런데, 회원 조회, 회원 등록, 회원 수정, 회원 삭제는 어떻게 구분하지???
리소스와 행위 분리
- 리소스와 해당 리소스를 대상으로 하는 행위를 분리
리소스: 회원
행위: 조회, 등록, 삭제, 변경- 리소스는 명사, 행위는 동사
행위는 어떻게 구분함? -> GET, POST 같은 HTTP 메서드
요구사항 - API URI 설계 (최종)
| 기능 | Method | URI |
|---|---|---|
| 회원 목록 조회 | GET | /members |
| 회원 조회 | GET | /members/{id} |
| 회원 등록 | POST | /members/{id} |
| 회원 수정 | PUT | /members/{id} |
| 회원 삭제 | DELETE | /members/{id} |
최종 모습은 이렇게 될 것이다...
2. HTTP 메서드 - GET, POST, PUT, PATCH, DELETE
메서드 종류
| Method | 설명 |
|---|---|
| GET | 리소스 조회 |
| POST | 요청 데이터 처리, 주로 등록에 사용 (사실상 만능) |
| PUT | 리소스를 대체, 해당 리소스가 없으면 생성 |
| PATCH | 리소스 부분 변경 |
| DELETE | 리소스 삭제 |
| HEAD | GET과 동일하지만 메시지 본문 제외, 상태 줄과 헤더만 반환 |
| OPTIONS | 대상 리소스의 통신 가능 옵션(메서드) 설명, 주로 CORS에서 사용 |
| CONNECT | 대상 자원 서버에 대한 터널 설정 (거의 사용하지 않음) |
| TRACE | 대상 리소스 경로를 따라 메시지 루프백 테스트 수행 (거의 사용하지 않음) |
GET
리소스 조회
1. 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달
2. 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않음
POST
요청 데이터 처리
1. 메시지 바디를 통해 서버로 요청 데이터 전달
2. 서버는 요청 데이터를 처리 - 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
3. 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
참고
응답 코드로 200 ok 대신에 201 Created 쓰기도 한다.
단, 이 때는 리소스가 위치하는 정보인 Location: /members/100 정보도 함께 보내준다.
요청 데이터 처리한다는 것의 의미
공식 스펙: POST 메서드는 대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청합니다.
예시
- HTML 양식에 입력된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
HTML FORM에 입력한 정보로 회원 가입, 주문 등에서 사용- 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시
게시판 글쓰기, 댓글 달기- 서버가 아직 식별하지 않은 새 리소스 생성
신규 주문 생성- 기존 자원에 데이터 추가
한 문서 끝에 내용 추가하기
POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 함 즉, 정해진 것이 없다
POST 정리
- 새 리소스 생성(등록)
- 서버가 아직 식별하지 않은 새 리소스 생성
- 요청 데이터 처리
- 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
ex) 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우 - POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
ex) POST /oreders/{orderId}/start-delivery (컨트롤 URI) <- 행위의 URI가 나올 수도 있다!
- 다른 메서드로 처리하기 애매한 경우
ex) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
애매하면 조회라도 POST로 가능하다.
메시지를 내부에 담아서 할 수 있는 것들, POST는 모든 것을 할 수 있다.
단, 조회는 캐싱 때문에 GET이 유리, POST는 캐싱을 하기 어렵다.
PUT
리소스를 대체
1. 리소스가 있으면 대체
2. 리소스가 없으면 생성
쉽게 이야기해서 덮어버림
POST와 차이점으로 클라이언트가 리소스를 식별한다.
클라이언트가 리소스 위치를 알고, URI 지정하여 요청을 보낸다.
주의
리소스를 완전히 대체한다.
여러 필드 중에 하나만 수정하고 싶다고 하나만 넣으면, 나머지 기존 필드 데이터는 날아간다.
PATCH
리소스 부분 변경
PATCH가 지원이 안되는 서버가 있다. 그런 경우는 POST를 쓰면 된다!
DELETE
리소스 제거
3. HTTP 메서드의 속성
Safe(안전)
호출해도 리소스를 변경하지 않는다.
Q: 그래도 계속 호출해서, 로그 같은게 쌓여서 장애가 발생하면?
A: 안전은 해당 리소스만 고려한다. 그런 부분까지 고려하지 않는다
안전을 판단할 땐, 리소스만!
Idempotent(멱등)
f(f(x)) = f(x)
한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다.
멱등 메서드
GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
PUT: 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
멱등이 아닌 메서드
POST: 멱등이 아니다. 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.
멱등 개념 활용 분야
자동 복구 메커니즘
서버가 TIMEOUT 등으로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시 해도 되는가에 대한 판단 근거가 된다.
Q: 재요청 중간에 다른 곳에서 리소스를 변경해버리면?
사용자1: GET -> username: A, age: 20
사용자2: PUT -> username: A, age: 30
사용자3: GET -> username: A, age: 30
A: 멱등은 외부 요인으로 중간에 리소스가 변경되는 것까지는 고려하지는 않는다.
Cacheable(캐시가능)
응답 결과 리소스를 캐시
GET, HEAD, POST, PATCH 캐시가능
실제로 는 GET, HEAD 정도만 캐시로 사용
POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않다.
이 링크를 통해 구매하시면 제가 수익을 받을 수 있어요. 🤗
https://inf.run/YZxop
