HTTP API

1. HTTP API

- URI 설계에서 가장 중요한 것은 리소스 식별 -> 리소스를 URI에 매핑.

- 리소스와 행위를 분리한다. (리소스는 명사, 행위는 동사) -> 행위는 HTTP 메서드

 

ex.

회원 목록 조회	/members
회원 조회	/members/{id}
회원 등록	/members/{id}
회원 수정	/members/{id}
회원 삭제	/members/{id}

 

 

2. HTTP 메서드 

1) 주요 메서드

• GET : 리소스 조회
• POST : 요청 데이터 처리, 주로 등록에 사용
• PUT : 리소스를 대체, 해당 리소스가 없으면 생성
• PATCH : 리소스 부분 변경
• DELETE : 리소스 삭제

2) 기타 메서드

• HEAD : GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
• OPTIONS : 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명 (주로 CORS에서 사용)
• CONNECT : 대상 리소스로 식별되는 서버에 대한 터널을 설정 
• TRACE : 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행

 

3) GET 

: 리소스 조회. 서버에 전달하고 싶은 데이터는 query를 통해서 전달. 

메시지 바디를 사용해서 데이터 전달 가능하지만, 지원하지 않는 곳이 많아 권장되지 않음. 

 

4) POST

: 요청 데이터 처리. 메시지 바디를 통해 서버로 요청 데이터 전달.

- 서버는 요청 데이터를 처리.

- 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용. 

 

• HTML 양식에 입력 된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공. (HTML FORM에 입력한 정보로 회원가입)
• 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시 (게시판 글쓰기, 댓글 달기)
• 서버가 아직 식별하지 않은 새 리소스 생성 (신규 주문 생성)
• 기존 자원에 데이터 추가 (한 문서 끝에 내용 추가하기)
• >> 이 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야함. (정해진 것이 없음)

+ 컨트롤 URI : POST의 결과로 새로운 리소스가 생성되지 않을 수 있음. 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우. 

 

5) PUT

: 리소스를 대체. (리소스가 있으면 대체 & 리소스가 없으면 생성)

- 클라이언트가 리소스를 식별하여 URI를 지정.

 

ex. 리소스가 있는 경우

 

ex. 리소스가 없는 경우

 

 

** 주의** 리소스를 완전히 대체한다...! 리소스를 수정하기는 어렵다.

 

6) PATCH

: 리소스 부분 변경

 

7) DELETE

: 리소스 제거 

 

 

 

3. HTTP 메서드의 속성

 

1) 안전 (Safe Methods)

: 호출해도 리소스를 변경하지 않는다. 

cf) Q : 그래도 계속 호출해서, 로그 같은게 쌓여서 장애가 발생한다면...? -> 안전은 해당 리소스만 고려한다. 

 

2) 멱등 (Idempotent Methods)

: 한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다. 

• GET : 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
• PUT : 결과를 대체한다. 따라서 같은 요청을 여러번 해도 결과는 같다.
• DELETE : 결과를 삭제한다. 같은 요청을 여러 번 해도 삭제된 결과는 똑같다.

cf) POST : 멱등이 아니다! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다...!

 

+ 활용

• 자동 복구 매커니즘
• 서버가 TIMEOUT 등으로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시 해도 되는가? 판단 근거

cf) Q : 재요청 중간에 다른 곳에서 리소스를 변경해버리면 ? -> 멱등은 외부 요인으로 중간에 리소스가 변경되는 것까지는 고려하지 않는다. 

 

3) 캐시가능 (Cacheable Methods) 

: 응답 결과 리소스를 캐시해서 사용해도 되는가? 

- GET, HEAD, POST, PATCH 캐시가능

- 실제로는 GET, HEAD 정도만 캐시로 사용. (POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않음)

 

 

 

 

 

---

** 해당 내용은 김영한님의 강의를 수강하며 정리한 것입니다.

https://www.inflearn.com/course/http-%EC%9B%B9-%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC/dashboard

모든 개발자를 위한 HTTP 웹 기본 지식 강의 | 김영한 - 인프런