1. API URI의 좋은 설계
URI 설계할 때, 가장 중요한 것은 '리소스(resource)의 식별'
1.1 리소스란
동작을 제외한 자원 그 자체를 리소스라 한다. 회원 등록 시스템을 생각해보면, 회원을 등록하고 수정하고 삭제하는 행위는 리소스가 아니다. 오직 회원이 리소스가 된다. (리소스의 대부분은 '명사'이다)
1.2 리소스 기반 회원 관리 URI 설계
동작은 HTTP 메소드로 구분(ex. GET, POST, PUT 등)
- 회원 목록 조회 : /members
- 회원 조회 : /members/{id}
- 회원 등록 : /members/{id}
- 회원 수정 : /members/{id}
- 회원 삭제 : /members/{id}
Tip. 계측 구조상 상위 자원을 컬렉션으로 보고 복수단어 사용 권장 (ex. member -> members)
2. HTTP 메소드 - GET, POST
2.1 개요
주요 메소드
- GET: 리소스 조회
- POST: 요청 데이터 처리 (주로, 등록에 사용)
- PUT: 리소스를 대체, 해당 리소스가 없으면 생성
- PATCH: 리소스 부분 변경
- DELETE: 리소스 삭제
기타 메소드
- HEAD: GET과 동일하지만, 메세지 부분을 제외하고 상태 줄과 헤더만 반환
- OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메소드)을 설명 (주로, CORS에 사용)
- CONNECT: 대상 자원으로 식별되는 서버에 대한 터널을 설정
- TRACE: 대상 리소스에 대한 경로를 따라 메세지 루프백 테스트를 수행
2.2 GET
- 리소스 조회
- 서버에 전달하고 싶은 데이터는 query를 통해 전달
- 메세지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많으므로 권장하지 않음
리소스 조회 1 - 메세지 전달
리소스 조회 2 - 서버 도착
리소스 조회 3 - 응답 데이터
2.3 POST
- 요청 데이터 처리
- 메세지 바디를 통해 서버로 요청 데이터 전달
- 서버는 요청 데이터를 처리
- 메세지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
- 주로, 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
리소스 등록 1 - 메세지 전달
리소스 등록 2 - 신규 리소스 생성
리소스 등록 3 - 응답 데이터
참고 예시. POST 요청 데이터를 어떻게 처리한다는 뜻일까?
- 스펙 : POST 메소드는 대상 리소스가 리소스의 고유 한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청한다.
- 예를 들어, POST는 다음 기능을 사용한다
- HTML 양식에 입력 된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공 (ex. HTML Form에 입력한 정보로 회원 가입, 주문 등에 사용)
- 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메세지를 게시 (ex. 게시판 글쓰기, 댓글쓰기)
- 서버가 아직 식별하지 않은 새 리소스 생성 (ex. 신규 주문 생성)
- 기존 자원에 데이터 추가 (ex. 한 문서 끝에 내용 추가)
3. HTTP 메소드 - PUT, PATCH, DELETE
3.1 PUT
- 리소스를 대체
- 리소스가 있으면, 대체
- 리소스가 없으면, 생성
- 중요. 클라이언트가 리소스를 식별한다.(클라이언트가 리소스 위치를 알고 URI 지정)
리소스 있는 경우
리소스 없는 경우
(주의) 리소스를 완전히 대체
3.2 PATCH
리소스의 부분 변경
3.3 DELETE
리소스 제거
4. HTTP 메소드의 속성
4.1 안전(Safe methods)
- 호출해도 리소스를 변경하지 않는다.
- 그럼에도 계속 호출해서 로그가 쌓여서 장애가 발생하면? -> 안전은 해당 리소스만 고려한다.(로그 같은건 고려하지 않음)
4.2 멱등(Idempotent methods)
한 번 호출하든, 두 번 호출하든, 100번을 호출하든 결과는 똑같다.
멱등메소드
- GET: 언제나 같은 결과를 조회함
- PUT: 결과를 대체함. 같은 요청 여러 번 해도 최종 결과는 같음
- DELETE: 결과를 삭제함. 같은 요청 여러 번 해도 삭제된 결과는 같음
- POST: 멱등이 아니다. 두 번 호출하면 같은 결제가 중복해서 발생할 수 있음
활용
- 자동복구 메커니즘
- 서버가 Timeout 등으로 정상 응답을 못할 때, 클라이언트가 같은 요청을 다시 해도 되나?
재요청 중간에 다른 곳에서 리소스를 변경한다면? -> 멱등은 외부 요인으로 중간에 리소스가 변경되는 것까지는 고려하지 않음
4.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
'Computer Science > Network' 카테고리의 다른 글
[Network] HTTP 웹 기본 지식 - 6. HTTP 상태 코드 (0) | 2023.02.09 |
---|---|
[Network] HTTP 웹 기본 지식 - 5. HTTP 메소드 활용 (0) | 2023.02.09 |
[Network] HTTP 웹 기본 지식 - 3. HTTP 기본 개념 (0) | 2023.02.08 |
[Network] HTTP 웹 기본 지식 - 2. URI와 웹 브라우저 요청 흐름 (0) | 2023.02.07 |
[Network] HTTP 웹 기본 지식 - 1. 인터넷과 네트워크 (0) | 2023.02.06 |