간단한 HTTP API 설계 예시를 통해 HTTP 메서드가 왜 필요한지에 대해 알아보겠다.
[요구사항]
"회원 정보 관리 API를 만들어라"
회원 목록 조회
회원 조회
회원 등록
회원 수정
회원 삭제
위와 같은 요구사항에서 초보 개발자들은 다음과 같은 실수를 저지른다.
"이해하기 편하도록 이름을 잘 지어서 URI를 기준으로 구현해볼까?"
[API URI(Uniform resource Identifier) 설계]
회원 목록 조회 /read-member-list
회원 조회 /read-member-by-id
회원 등록 /create-member
회원 수정 /update-member
회원 삭제 /delete-member
초보 개발자들은 이것을 보고 URI 설계를 잘 했다고 착각 할 수도 있다.
하지만
이것이 진짜 좋은 URI 설계일까?
■ API URI 설계
URI 설계에서 가장 중요한 것은 "리소스를 식별"
- 회원을 등록, 수정, 조회하는 것이 리소스가 아니다. - 회원이라는 개념 자체가 리소스 - 따라서 리소스를 어떻게 식별하는게 좋을지 고민하려면 - 회원을 등록, 수정, 조회하는 것을 모두 배제하고 회원이라는 리소스만 식별하도록 한다.
"회원" 개념만을 리소스로 식별하고, URI의 계층 구조를 활용하여 API를 설계한다.
1) API URI 설계 : 리소스를 식별, URI의 계층 구조 활용 - 회원 목록 조회 /members - 회원 조회 /members/{id} -> 어덯게 구분하지? - 회원 등록 /members/{id} -> 어덯게 구분하지? - 회원 수정 /members/{id} -> 어덯게 구분하지? - 회원 삭제 /members/{id} -> 어덯게 구분하지?
- URI는 리소스만을 식별 - 리소스와 해당 리소스를 대상으로 하는 행위를 분리 - 리소스 : 회원 - 행위 : 조회, 등록, 수정, 삭제
그렇다면 행위(메서드)는 어떻게 구분할까?
2) HTTP 메서드 HTTP 메서드는 클라이언트가 서버에게 무언가를 요청할 때 서버에게 기대하는 행동 [HTTP 주요 메서드] - GET : 리소스 조회 - POST : 요청 데이터 처리, 주로 등록에 사용 - PUT : 리소스를 대체, 해당 리소스가 없으면 새롭게 생성(폴더에 파일이 있으면 덮어쓰고, 없으면 생성하는 것과 같다.) - PATCH : 리소스 부분 변경, 리소스의 일부 필드를 변경할 때 사용 - DELETE : 리소스 삭제
■ HTTP 주요 메서드
1) GET - 리소스를 조회 - 서버에 전달하고 싶은 데이터를 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달 - 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않음
[동작 과정] 1. 클라이언트가 메시지에 정보를 담아 서버에 조회 요청
2. 서버에 메시지가 도착, 메시지를 확인
3. 서버가 메시지에서 조회에 필요한 데이터를 가지고 데이터베이스에서 조회하여 응답 결과가 포함된 메시지를 생성 후 클라이언트에게 전달 2) POST - 클라이언트의 요청 데이터를 서버에서 처리 - 메시지 바디를 통해 서버로 요청 데이터를 전달 - 서버는 요청 데이터를 처리 - 주로 전달된 데이터로 신규 리소스를 등록하거나 변경된 프로세스를 처리하는데 사용
[동작 과정] 1. 클라이언트가 전송하는 해당 데이터는 서버가 내부적으로 처리하도록 약속 2. 클라이언트가 요청 데이터(/members)를 POST로 전송 3. 서버에서 해당 데이터를 전송받아 확인 후 스스로 내부 로직을 처리 - 데이터베이스에 신규 데이터 등록, 신규 식별자 생성하여 응답할 데이터를 생성 [POST가 사용되는 예시]
1) HTML 양식에 입력 된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공 - HTML FORM에 입력한 정보로 회원 가입, 주문 등에서 사용
2) 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지를 게시 - 게시판 글쓰기, 댓글 달기
3) 서버가 아직 식별하지 않은 새 리소스를 생성 - 신규 주문 생성
4) 기존 자원에 데이터를 추가 - 한 문장 끝에 내용 추가
3) PUT - 리소스가 있으면 대체, 없으면 새로 생성 - 예를 들어, 파일을 복사하는 것과 비슷하다. 기존 파일이 없으면 생성하고, 기존 파일이 있으면 덮어쓰기를 한다. - 중요한 것은 클라이언트가 리소스 위치를 알고 URI를 지정, 클라이언트가 리소스를 식별 (POST와 차이점) - PUT은 리소스를 완전히 대체, 기존 데이터가 삭제되고 PUT에 포함되어 있는 요청 데이터로 완전히 대체
4) PATCH - PATCH는 PUT처럼 리소스를 완전히 대체하지 않고부분 변경하는데 사용 - 리소스의 일부 데이터를 부분적으로 변경하고 싶을 때 사용 - 리소스의 위치를 직접 지정
[참고] - 리소스를 부분 변경해야할때 PATCH를 사용하지만 지원하지 않는 서버도 있다고 한다. 그럴경우에는 POST를 사용
5) DELETE - 리소스를 제거할 때 사용 - 리소스의 위치를 직접 지정
■ HTTP 메서드의 속성
HTTP 메서드는 다음과 같은 속성을 가지고 있다. 1) 안전(Safe Methods) - 호출해도 리소스를 변경하지 않는다. - POST, PUT, PATCH, DELETE 등과 같이 호출했을 때 변경이 일어나는 메서드는 안전하지 않다.
2) 멱등(Idempotent Methods) - 한번 호출하든 두번 호출하든 100번 호출하든 결과가 똑같다. - 멱등이라는 개념은 자동 복구 메커니즘에 활용 - 서버가 정상적인 응답을 주지 못하였을 때(예를 들면, TIMEOUT) 클라이언트가 같은 요청을 다시 해도 되는지에 대한 판단 근거
[Q. 요청 중간에 다론 곳에서 리소스 변경이 이루어진다면?] ■ 예) 사용자 1 : GET -> userName : A, age : 20 ■ 예) 사용자 2 : PUT -> userName : A, age : 30 ■ 예) 사용자 1 : GET -> userName : A, age : 30
- 사용자 2의 영향으로 마지막에 사용자 1이 데이터를 조회 시, 바뀐 데이터가 조회된다. 이 상황에서 GET은 멱등하지 않은 것인가요? - 멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지 않는다.
[멱등 메서드] - GET : 한번 조회하든, 두번 조회하든 같은 결과가 조회 - PUT : 결과를 대체, 같은 요청을 여러번 해도 최종 결과는 같다. - DELETE : 결과를 삭제, 같은 요청을 여러번 해도 삭제된 결과는 같다.
- POST : 멱등 X, 두번 호출하면 같은 행위(주문 결제)가 중복해서 발생할 수 있다.
3) 캐시기능(Cacheable Methods) - 응답 결과 리소스를 캐시해서 사용해도 되는가? - GET, HEAD, POST, PATCH 캐시 가능 - 실제로는 GET, HEAD 정도만 캐시를 사용 - POST, PATCH의 경우, 본문 내용까지 캐시 키로 고려해야하는데 구현이 쉽지 않다.
■ HTTP 메서드 활용
클라이언트에서 서버로 데이터를 전송할 때, HTTP API 설계 시 HTTP 메서드가 어떻게 활용되는지에 대해 알아보겠습니다.
[클라이언트에서 서버로 데이터를 전송하는 방식은 크게 2가지] 1) 쿼리 파라미터를 통한 데이터 전송 - GET - 주로 정렬 필터(검색어)에 사용
2) 메시지 바디를 통한 데이터 전송 - POST, PUT, PATCH - 회원 가입, 상품 주문, 리소스 등록, 리소스 변경할 때 사용
[클라이언트에서 서버로 데이터를 전송하는 전달 방식에 대한 4가지 예시] 1) 정적 데이터 조회 - 주로 이미지, 정적 텍스트 문서 조회에 사용 - GET 사용 - 정적 데이터는 일반적으로 쿼리 파라미터 없이 리소스 경로로 단순하게 조회가 가능
2) 동적 데이터 조회 - 클라이언트가 쿼리 파라미터를 기반으로 데이터를 전달해서 동적 데이터 결과를 조회할 때 사용 - 주로 검색, 게시판 목록에서 정렬 필터(검색어)에 사용 - GET 사용
3) HTML Form을 통한 데이터 전송 - 회원 가입, 상품 주문, 데이터 변경 - HTML FORM 태그를 submit 시, POST 전송 - Content-Type : application/x-www-form-urlencoded 사용 - form의 내용을 메시지 바디를 통해 전송(key-value, 쿼리 파라미터 형식) - 전송 데이터를 url encoding 처리 - HTML Form은 GET 전송도 가능 : 데이터를 저장할 땐 X, 데이터 조회에 사용 - Content-Type : multipart/form-data - 파일 업로드 같은 바이너리 데이터 전송 시 사용 - 웹 브라우저가 Content-Type에 boundary를 자동으로 추가, boundary로 Content-Type을 구분해서 여러 형식의 form 데이터를 전송 - 다른 종류의 여러 파일과 폼의 내용 함께 전송 가능 - HTML FORM 전송은 GET, POST만 지원 4) HTTP API를 통한 데이터 전송 ■ 서버 to 서버 - 백앤드 시스템 통신에 사용 - HTML 태그가 전혀 없다.
■앱 클라이언트 - 아이폰, 안드로이드와 같은 앱 클라이언트에서도 사용
■웹 클라이언트(AJax) - HTML에서 Form 전송 대신 자바스크립트를 통한 통신에 사용(AJAX)
■ HTTP API 설계 예시
HTTP URI를 어떻게 설계하는지 설계 예시를 알아보겠습니다.
1) HTTP API - 컬렉션 - POST 기반 등록 API 설계 - 예) 회원 관리 API 제공
■ 회원 목록 /members -> GET, 회원 데이터를 쿼리 파라미터로 정렬/조회 ■ 회원 등록 /members -> POST, 신규 회원 데이터 추가 ■ 회원 조회 /members/{memberid} -> GET, 특정 회원 데이터 조회 ■ 회원 수정 /members/{memberid} -> PATCH(회원 데이터 부분 수정), PUT(회원 데이터 대체), POST ■ 회원 삭제 /members/{memberid} -> DELETE, 회원 데이터 삭제
[POST로 신규 자원을 등록할 경우의 특징] - 클라이언트는 등록될 리소스의 URI를 모른다.
2) HTTP API - 스토어 - PUT 기반 등록 API 설계 - 예) 파일 관리 시스템
