1. HTTP API 만들기
API URI(Uniform Resource Identifier)를 설계 시에 중요한 것은 리소스의 식별입니다.
예를 들어, 회원을 등록, 수정, 조회, 삭제하는 기능을 설계한다고 가정해보겠습니다.
- 회원 목록 조회 /read-member-list
- 회원 조회 /read-member-by-id
- 회원 등록 /create-member
- 회원 수정 /update-member
- 회원 삭제 /delete-member
여기서 회원을 등록하고 수정하고 조회하는 동작은 리소스가 아닙니다. 여기서의 리소스는 회원이라는 개념입니다. 더 쉽게 예를 들자면 미네랄을 캐라는 명령에서 캐는 행위가 리소스인 것이 아니라 미네랄이 리소스입니다.
그래서 위 예시처럼 URI를 설계한다면 리소스가 명확히 드러나지 않습니다. 동작이 URI에 포함되어있기 때문입니다.
- 회원 목록 조회 /members
- 회원 조회 /members/{id}
- 회원 등록 /members/{id}
- 회원 수정 /members/{id}
- 회원 삭제 /members/{id}
그래서 위처럼 동작을 배제하고 회원이라는 리소스를 식별해 URI에 매핑하는 것이 좋은 URI 설계입니다.
(참고로 계층 구조상 상위를 컬렉션으로 보고 복수단어 사용 권장(member -> members)합니다.)
정리하자면 URI는 리소스를 식별하는 것이고, 리소스와 해당 리소스를 대상으로 하는 행위를 분리합니다. 위에서는 리소스가 회원이고, 행위는 조회, 등록, 삭제, 변경 등의 기능입니다.
그러면 이제 저 똑같은 URI에서 행위(메서드)는 어떻게 구분할 것인가에 대한 문제가 생깁니다.
2. HTTP 메서드 종류
위 문제는 HTTP 메서드로 해결합니다. 즉 리소스는 URI로 식별하고, 행위는 HTTP 메서드로 구분합니다.
메서드는 클라이언트가 서버에 요청할 때 기대하는 행동이라고 볼 수 있습니다. 가장 많이 사용하는 메서드의 종류는 아래와 같습니다.
- GET: 리소스 조회
- POST: 요청 데이터 처리, 주로 등록에 사용
- PUT: 리소스를 대체, 해당 리소스가 없으면 생성
- PATCH: 리소스 부분 변경
- DELETE: 리소스 삭제
추가로 아래와 같은 기타 메서드가 있습니다.
- HEAD: GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
- OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)
- CONNECT: 대상 리소스로 식별되는 서버에 대한 터널을 설정
- TRACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행
(1) GET
리소스를 조회하는 것입니다.
서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달합니다.
메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않습니다.
만약 서버에 위와 같이 GET/members/100 HTTP/1.1이라는 요청을 보낸다면, 서버는 100번에 해당하는 멤버를 가져옵니다.
서버에서는 응답 메시지를 만들어 클라이언트에게 다시 보냅니다.
(2) POST
클라이언트에서 서버로 요청을 보낼때 데이터를 담아보내는 메서드입니다.
클라이언트가 메시지 바디를 통해 서버로 요청 데이터 전달합니다. 그러면 서버는 요청 데이터를 처리하는데, 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행합니다. 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용됩니다.
클라이언트가 서버에게 /members로 URI 요청을 보냅니다. 이때 메시지 바디에 필요한 데이터를 실어 보냅니다.
서버에서는 신규 리소스 식별자(그림에서는 100)를 생성합니다. 그리고 다시 클라이언트에게 응답 메시지를 보냅니다. 여기에는 경로와 등록된 데이터가 있습니다.
POST의 요청 데이터 처리
POST가 데이터를 등록하는 것이라고 생각할 수 있지만, 좀 더 자세히 알아보면 등록한다는 의미는 아닙니다.
POST 메서드는 엄밀히 말하자면, 대상 리소스가 리소스에 따라 요청에 포함된 표현을 처리하도록 요청하는 것입니다. 그래서 POST는 다음과 같은 여러 기능에 사용됩니다.
- HTML 양식에 입력 된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
- HTML FORM에 입력한 정보로 회원 가입, 주문 등에서 사용 • 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시
- 게시판 글쓰기, 댓글 달기 • 서버가 아직 식별하지 않은 새 리소스 생성 • 예) 신규 주문 생성 • 기존 자원에 데이터 추가
- 한 문서 끝에 내용 추가하기
즉, URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해주어야 하는 것입니다.
정리하자면 POST의 쓰임은 아래와 같습니다.
- 새 리소스 생성(등록)
서버가 아직 식별하지 않은 새 리소스 생성할 때 사용됩니다. 위 그림에서 member 등록을 요청했을 때 100의 멤버 번호를 부여한 것을 볼 수 있었습니다. - 요청 데이터 처리
• 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우에 사용됩니다. 예를 들어, 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우에 사용됩니다.
• POST의 결과로 새로운 리소스가 생성되지 않을 수도 있습니다. 예를 들어 POST /orders/{orderId}/start-delivery 처럼 동사의 URI인 컨트롤 URI가 나올 수 있습니다. 리소스로만 최대한 URI를 설계하도록 설명했지만, 어쩔 수 없는 부분들은 컨트롤 URI를 통해 설계합니다. - 다른 메서드로 처리하기 애매한 경우
POST는 데이터를 담아 보내는 모든 동작을 수행할 수 있습니다. 그래서 JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우에 사용할 수 있습니다. 하지만 조회할 때에는 최대한 GET 메서드를 사용하는 것이 좋습니다.
(3) PUT
PUT은 리소스를 대체하는 역할을 수행합니다. 리소스가 있으면 완전히 대체하고 리소스가 없으면 생성합니다. 쉽게 말해 덮어버리는 역할을 수행합니다.
POST와 다른 것은 POST는 서버에서 리소스의 경로를 설정했지만, PUT은 클라이언트가 구체적인 리소스의 경로를 알고 URI를 지정합니다.
그래서 요청 시에 리소스의 경로를 지정해서 요청을 보내는 것을 볼 수 있습니다.
중요한 것은 리소스를 완전히 대체한다는 것입니다. 위 그림에서 username 필드를 없애고 age를 다르게 해서 서버에 요청하면, age만 변경되는 것이 아닌 모든 데이터가 날아가고 age만 남게 됩니다.
만약 리소스를 대체하는 것이 아닌 부분만 교체하기 위해서는 PATCH 라는 메서드를 사용합니다.
(3) PATCH
PATCH는 리소스의 부분을 변경하는 메서드입니다.
PATCH로 age 부분을 변경해서 서버에 요청한 것입니다.
그럼 서버에서는 age만 변경합니다. 부분적으로 데이터를 변경할 때 유용합니다.
PATCH가 서버에서 지원이 안되는 경우도 있습니다. 그럴 때에는 POST를 사용하면 됩니다.
(5) DELETE
리소스를 제거하는 메서드입니다.
해당 리소스의 경로를 DELETE를 통해 요청하면
해당 리소스는 사라지게 됩니다.
HTTP 메서드의 속성
HTTP 메서드에는 위에서 다루었던 내용외에도 안전, 멱등, 캐시 가능 등의 속성이 있습니다.
(1) 안전 (Safe)
호출해도 리소스를 변경하지 않는다는 것입니다. 한번이든 여러번이든 호출 시에 리소스가 변경되지 않습니다. 그래서 POST, PUT, DELETE 등은 리소스가 변경되기 때문에 안전하지 않습니다.
(2) 멱등 (Idempotent)
함수로 표현하자면 f(f(x)) = f(x)로, 한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같은 것입니다.
멱등 메서드는 아래와 같습니다.
- GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회됩니다.
- PUT: 결과를 대체합니다. 따라서 같은 요청을 여러번 해도 최종 결과는 같습니다.
- DELETE: 결과를 삭제합니다. 같은 요청을 여러번 해도 삭제된 결과는 똑같습니다.
반면 POST는 멱등이 아닙니다. 두 번 호출하면 같은 내용이 중복되어 저장되는 등의 문제가 발생할 수 있습니다.
멱등은 자동 복구 메커니즘에 활용됩니다. 만약 서버가 TIMEOUT 등으로 정상 응답을 못주었을 때, 동일한 클라이언트가 같은 요청을 다시 해도 괜찮은 지에 대한 판단 근거를 제공합니다.
(3) 캐시가능
응답 결과 리소스를 캐시해서 사용해도 되는지에 대한 것입니다.
GET, HEAD, POST, PATCH는 캐시가 가능하지만 실제로는 GET, HEAD 정도만 캐시로 사용합니다. 캐시를 사용하기 위해서는 리소스와의 key가 맞아야하는데 POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하기 때문에 구현하기가 매우 어렵습니다.
참고자료
[인프런 김영한 - 모든 개발자를 위한 HTTP 웹 기본 지식]
https://www.inflearn.com/course/http-%EC%9B%B9-%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC/dashboard
'Backend > HTTP' 카테고리의 다른 글
[HTTP] HTTP 상태코드 (모든 개발자를 위한 HTTP 웹 기본 지식 - 섹션 6) (0) | 2023.04.25 |
---|---|
[HTTP] HTTP 메서드 활용 (모든 개발자를 위한 HTTP 웹 기본 지식 - 섹션 5) (0) | 2023.04.25 |
[HTTP] HTTP 기본 (모든 개발자를 위한 HTTP 웹 기본 지식 - 섹션 3) (0) | 2023.04.20 |
[HTTP] URI와 웹 브라우저 요청 흐름 (모든 개발자를 위한 HTTP 웹 기본 지식 - 섹션 2) (0) | 2023.04.18 |
[HTTP] 인터넷 네트워크 (모든 개발자를 위한 HTTP 웹 기본 지식 - 섹션 1) (0) | 2023.04.17 |