해당 자료는 인프런 강의 김영한 님의 모든 개발자를 위한 HTTP 웹 기본 지식 강의를 참고하였다.
API URI 설계
- 좋은 URI 설계 ( 가장 중요한 것은 리소스 식별)
- 리소스의 의미는?
- 회원을 등록하고 수정하고 조회하는게 리소스가 아니다.
- 예) 미네랄을 캐라 -> 미네랄이 리소스
- 회원이라는 개념 자체가 바로 리소스다.
- 리소스를 어떻게 식별하는게 좋을까?
- 회원을 등록하고 수정하고 조회하는 것을 모두 배제
- 회원이라는 리소스만 식별하면 된다. -> 회원 리소스를 URI에 매핑
리소스와 행위를 분리, 가장 중요한 것은 리소스를 식별하는 것
URI는 리소스만 식별!
- 리소스와 해당 리소스를 대상으로 하는 행위를 분리
- 리소스 : 회원
- 행위 : 조회, 등록, 삭제, 변경
- 리소스는 명사, 행위는 동사(미네랄을 캐라)
- 행위(메서드)는 어떻게 구분?
HTTP 메서드 - GET, POST
GET
- 리소스 조회,
- 서버에 전달하고 싶은 데이터는 query(쿼리파라미터, 쿼리 스트링)를 통해서 전달
- 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않음
POST
- 메시지 바디를 통해 서버로 요청 데이터 전달
- 서버는 요청 데이터를 처리
- 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
- 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
PUT
- 클라이언트에서 리소스를 서버로 보냄
- 예를 들어 파일을 폴더에 넣음, 파일이 없다면? 파일을 생성 함 기존에 파일이 있다면? 덮어 버린다.
HEAD
- GET과 동일하지만, 바디부분을 빼고 헤더까지만 반환
POST - 요청 데이터를 어떻게 처리한다는 뜻일까?
-
HTML 양식에 입력 된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공 (HTML FORM에 입력한 정보)
-
게시판, 뉴스 그루브 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시 (게시판 글쓰기, 댓글 달기)
-
서버가 아직 식별하지 않은 새 리소스 생성
(신규 주문 생성) -
기존 자원에 데이터 추가
(한 문서 끝에 내용 추가 하기)
정리 : 이 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야함 -> 정해진 것이 없음
POST 정리
1. 새 리소스 생성(등록)
- 서버가 아직 식별하지 않은 새 리소스 생성
2. 요청 데이터 처리
-
단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
-
예) 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
-
POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음(서버에서 프로세스가 변화하는 경우)
- 예) POST /orders/{orderid}/start-delivery
- URI 설계할 때 리소스만으로 설계하라고 했지만 그렇게 안되는 경우도 있다...(control URI 라 한다.)
3. 다른 메서드로 처리하기 애매한 경우
-
예) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
(GET 메서드를 이용하여 메세지를 바디에 넣고 싶음.. GET메서드 메세지 바디를 서버측에서 지원하지 않는 경우가 많다... 이럴 경우 조회용이지만 POST로 사용) -
애매하면 POST
POST는 모든 것을 할 수 있다..(메세지를 내부에 담아서 보내는 모든것을 다 할수 있다.)
- 그렇지만 조회 할때는 GET을 사용하는 것이 유리하다.
- 예를 들어서 서버에서는 GET으로 오면 캐싱, POST로 오면 캐싱을 하기 어려움
HTTP 메서드 - PUT, PATCH, DELETE
PUT
- 리소스를 대체 (완전히 대체)
- 리소스가 없으면 생성
- 쉽게 이야기 해서 덮어버림
PUT /memvers/100
중요! 클라이언트가 리소스를 식별
- 클라이언트가 리소스 위치를 알고 URI 지정( 구체적인 리소스 전체 경로 알고 있다. --> POST와 차이점)
PATCH
- 리소스 부분 변경
DELETE
- 리소스 제거
