김영한 님의 모든 개발자를 위한 HTTP 웹 기본 지식 강의를 보고 작성한 내용입니다.
https://www.inflearn.com/course/http-%EC%9B%B9-%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC/dashboard
1. API URI 설계
-
API URI를 설계할 때 가장 중요한 것은 리소스 식별이다
-
리소스 : 등록, 수정, 조회가 이루어지는 대상
- 회원 정보 관리 API 에서는 회원이 리소스
-
회원이라는 리소스를 식별하면 된다 -> 회원 리소스를 URI에 매핑
-
URI는 계층 구조로 작성
-
회원 조회, 등록, 수정, 삭제 URI :
/members/{id} -
모두 같은 URI --> 그렇다면 어떻게 구분???
-
-
리소스와 행위를 분리한다
-
리소스(명사) : 회원
-
행위(동사) : 리소스를 대상으로 하는 행위 ( 조회, 등록, 삭제, 변경 )
-
URI는 리소스를 식별하는데 사용한다 ( 행위를 식별하는데 사용하지 않는다 )
-
행위를 구분하기 위해서 HTTP method를 사용 ( GET, POST 등 )
-
2. HTTP method 종류
-
GET : 리소스 조회
-
POST : 요청 데이터 처리, 주로 등록에 사용
-
PUT : 리소스를 대체, 해당 리소스가 없으면 생성 ( 파일을 폴더에 넣는 것과 유사 )
-
PATCH : 리소스 부분 변경
-
DELETE : 리소스 삭제
-
HEAD : GET과 동일하지만 HTTP 메세지에서 body 부분을 제외하고, start-line, header-lines만 반환
-
OPTIONS : 대상 리소스에 대한 통신 가능 옵션 ( 메서드 ) 을 설명 (주로 CORS에서 사용)
-
CONNECT : 대상 자원으로 식별되는 서버에 대한 터널을 설정
-
TRACE : 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행
3. GET
-
서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달
-
메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않음
-
GET에 대한 Response 메세지는 body 부분에 데이터를 담아서 보낸다
4. POST
4-1. 설명
-
요청 데이터 처리
-
HTTP 메세지의 body를 통해 서버로 요청 데이터 전달
-
서버는 HTTP 메세지의 body에 담긴 요청 데이터를 처리
-
주로 신규 리소스 등록, 프로세스 처리에 사용
-
데이터가 신규로 등록되었다면 Response 메세지의 헤더에 데이터가 어디에 저장되었는지를 나타내는
Location이 포함
-
-
요청 데이터를 처리한다는 것은 등록한다는 의미만 있는 것이 아님!!
-
처리한다는 것은 전달받은 데이터를 처리 프로세스에 제공하거나, 새로운 리소스를 생성, 기존 자원에 데이터를 추가하는 등 여러 가지 의미를 가진다
-
리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 함 -> 정해진 것이 없음
4-2. Post를 사용하는 경우
-
새 리소스 생성(등록)
- 서버가 아직 식별하지 않은 새 리소스 생성
-
요청 데이터 처리
-
단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
- ex> 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
-
POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
-
ex> POST /orders/{orderId}/start-delivery
-
위의 예시와 같은 동사형 URI = 컨트롤 URI
-
-
-
다른 메서드로 처리하기 애매한 경우
-
ex> JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우라면 조회이지만 POST를 사용해야한다
-
애매하면 POST를 사용한다고 생각
-
5. PUT / PATCH / DELETE
5-1. PUT
-
리소스를 대체
-
리소스가 있으면 대체 ( 덮어쓰기 )
-
리소스가 없으면 생성
-
-
리소스를 완전히 대체
-
예를 들어, 서버에 username, age 데이터가 있다고 가정했을 때
-
클라이언트가 age 데이터만 보내면 서버에 있는 username, age 데이터가 age 데이터로 변환 ( username 삭제됨 )
-
즉, 기존 데이터를 삭제하고 덮어쓴다, 부분적으로 수정할 수 없다
-
-
클라이언트가 리소스 위치를 알고 URI 지정 ( POST와 차이점 )
-
post는 어느 위치에 저장될 지 알 수 없음
-
PUT : /members/
100 -
POST : /memebers
-
5-2. PATCH
-
PUT 방식으로 리소스의 일부만 전달하게 되면, 아예 대체되어 버리기 때문에 저장되어 있던 내용이 사라진다
-
리소스의 일부분만 변경하고 싶은 경우에 PATCH 사용
-
PATCH를 지원하지 않는 경우에는 POST 방식을 사용
5-3. DELETE
- 리소스 제거
6. HTTP method의 속성
6-1. 안전 ( Safe )
-
호출해도 리소스를 변경하지 않는다 ( 변경이 일어나지 않는다 )
-
POST, PUT 처럼 리소스를 변화시키는 방식들은 안전하지 않다
6-2. 멱등 ( Idempotent )
-
한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다
-
멱등 메서드
-
GET : 몇 번을 조회해도 같은 결과가 조회된다
-
PUT : 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다
-
DELETE : 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다
-
POST : 멱등이 아니다. 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다
-
-
서버가 TIMEOUT 등으로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시 해도 되는가에 대한 판단 근거로 활용
- 예를 들어, DELETE를 요청했는데 결과를 받지 못했다. 이런 경우 DELETE는 멱등하기 때문에 다시 요청해도 괜찮다
6-3. 캐시가능 ( Cacheable )
-
응답 결과 리소스를 캐시해서 사용해도 되는가?
-
GET, HEAD, POST, PATCH 캐시가능
-
실제로는 GET, HEAD 정도만 캐시로 사용
-
GET은 URL만 키로 잡고 캐시로 하면 되게 쉽지만
-
POST, PATCH 는 본문 내용까지 캐시 키로 고려해야 하기 때문에 구현이 쉽지 않음
-
