API URI 설계
- 리소스 식별이 가장 중요하다.
- 리소스와 해당 리소스를 대상으로 하는 행위를 분리
예) 회원등록, 회원조회, 회원수정, 회원삭제......= 리소스 '회원' + 행위
*계층 구조상 상위 컬렉션으로 보고 복수단어 사용 권장 (members)
주요 메소드 종류
1_GET
리소스 조회
서버에 전달하고 싶은 데이터는 query를 통해서 전달
2_POST
새 리소스 생성(등록)
요청 데이터 처리, 메시지 바디를 통해 서버로 요청 데이터 전달
서버는 요청 데이터를 처리 (메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행)
*리소스 URI에 POST요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 함
다른 메소드로 처리하기 애매한 경우
3_PUT
리소스가 있으면 (완전히)대체, 없으면 생성 - (기존 리소스 삭제 후 대체) 덮어버림
클라이언트가 리소스 식별(위치를 알고 URI 지정 / POST와의 차이점)
4_PATCH
리소스 부분 변경
5_DELETE
리소스 제거
HTTP 메소드 속성
1_안전
호출해도 리소스를 변경하지 않는다.
2_역등
몇번을 호출하든 결과가 똑같다.
*외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지 않는다.
GET / PUT / DELETE (O) , POST (X)
자동 복구 매커니즘
서버가 TIMEOUT 등으로 정상 응답을 못주었을때, 클라이언트가 같은 요청을 다시 해도 되는가? 판단 근거가 된다.
3_캐시가능
응답 결과 리소스를 캐시해서 사용해도 되는가?
GET / HEAD / POST / PATCH (O) ...
실제로는 GET / HEAD 사용 (POST / PATCH 의 본문 내용까지 고려하기 힘듦)
'http' 카테고리의 다른 글
[HTTP]#6 HTTP API 설계 예시 (1) | 2023.12.06 |
---|---|
[HTTP]#5 HTTP 메소드 활용 (1) | 2023.12.06 |
[HTTP]#3 HTTP 기본 (1) | 2023.12.06 |
[HTTP]#2 URI와 웹 브라우저 요청 흐름 (1) | 2023.12.05 |
[HTTP]#1 인터넷 네트워크 (1) | 2023.12.05 |