API URI 설계시
-리소스의 의미?
-회원을 등록하고 수정하고 조회하는게 리소스가 아니라 회원이라는 개념 자체가 리소스
-리소스 식별?
-회원이라는 리소스만 식별하면됨 -> 회원 리소스를 URI에 매핑
-어떻게 구별?(리소스는 다 똑같음)
-먼저 리소스와 행위를 분리
-중요한 것은 리소스를 식별하는것
-URI는 리소스만 식별(행위 X)
-리소스: 회원
-행위: 조회, 등록, 삭제, 변경
-그럼 행위는 어떻게 구분하는가? HTTP 메서드
HTTP 메서드 종류
-GET: 리소스 조회
-POST: 요청 데이터 처리, 주로 등록에 사용
-PUT: 리소스를 대체(덮어쓰기), 해당 리소스가 없으면 생성
-PATCH: 리소스 부분 변경(수정)
-DELETE: 리소스 삭제
GET
-리소스 조회
-서버에 전달하고 싶은 데이터는 query(쿼리 파라미터)를 통해서 전달
-메시지 바디를 사용할수 있으나 권장하지 않음
POST(만능)
-요청 데이터 처리
-메시지 바디를 통해 서버로 요청 데이터 전달
-서버는 요청 데이터를 처리
-주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
-리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 지정해야 함
클라이언트-> 서버 | 서버-> 클라이언트 |
POST /members HTTP/1.1 Content-Type: application/json { "username": "young", "age": 20 } |
/members/100 (신규 리소스 식별자 생성) 서버-> 클라이언트 HTTP/1.1 201 Created Content-Type: application/json Content-Length: 34 Location: /members/100 (신규 생성 경로) { "username": "young", "age": 20 } |
POST 용도
1.새 리소스 생성(등록)
2.요청 데이터 처리
-e.g. POST /orders/{orderId}/start-delivery (컨트롤 URI 실무에선 어쩔수 없이 리소스와 행위도 보냄)
3.다른 메서드로 처리하기 애매한 경우
PUT
-리소스를 완전히 대체(파일 덮어버림과 유사)
-클라이언트에서 구체적 리소스를 식별(알고 지정)
-클라이언트가 리소스 위치를 알고 URI 지정
PUT /member/100 HTTP/1.1 Content-Type: application/json { "username": "hello", "age": 20 } |
PATCH
-리소스 부분 변경(PUT과 달리 기존 데이터에서 필요한 부분만 업데이트 가능)
DELETE
-리소스 제거
HTTP 메서드의 속성
-안전(Safe Methods)
-멱등(Idempotent Methods)
-캐시가능(Cacheable Methods)
안전
-호출해도 리소스를 변경하지 않음(e.g. GET)
멱등
-한번 호출하든 여러번 호출하든 결과가 똑같음
-GET: 여러번 조회하든 같은 결과가 조회됨
-PUT: 결과는 대체되나 같은 요청을 계속해도 결과는 같음
-DELETE: 결과는 삭제하나 같은 요청을 계속해도 결과는 같음
-POST: 멱등이 아님(e.g. 중복결제)
-활용
-자동 복구 메커니즘(DELETE 호출 -> 서버 응답 없음 -> 다시 요청(멱등이므로 가능))
-재요청 하는 사이에 다른 곳에서 리소스를 변경해버리면? 외부 변수까지는 고려하지 않음
캐시가능
-응답 결과 리소스를 캐시해서 사용해도 되는가?
-GET, HEAD, POST, PATCH 캐시 가능(실무는 GET 정도에서만 사용)
'웹 프로그래밍 > HTTP' 카테고리의 다른 글
HTTP 상태코드 (0) | 2023.02.24 |
---|---|
HTTP 메서드 활용 (0) | 2023.02.24 |
HTTP (0) | 2023.02.22 |
URI와 웹 브라우저 (0) | 2023.02.21 |
인터넷 네트워크 (0) | 2023.02.21 |