API URI 설계

좋은 URI 설계란 ? 리소스 식별이 가장 중요하다.

즉, 리소스와 행위를 분리

  • 리소스 - 명사 - 회원
  • 행위 - 동사 - 조회, 등록, 삭제, 변경
 

URI는 리소스만 식별

HTTP 메서드 종류

주요 메서드

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

기타 메서드

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

주요메서드 분석

GET

  • 리소스 조회
  • 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)으로 전달
  • 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않음
    request
    /members/100
    response
    GET /members/100 HTTP/1.1
    Host: localhost:8080
    {
       "username": "young",
       "age": 20
    }
    HTTP/1.1 200 OK
    Content-Type: application/json
    Content-Length: 34
    {
       "username": "young",
       "age": 20
    }

post

  • 요청 데이터 처리
  • 메시지 바디를 통해 서버로 요청 데이터 전달
  • 서버는 요청 데이터를 처리
  • 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행
  • 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
request
/members -> /members/100
신규 리소스 식별자 생성
response
POST /members HTTP/1.1
Content-Type: application/json

{
   "username": "young",
   "age": 20
}
{
   "username": "young",
   "age": 20
}
 
HTTP/1.1 201 Created
Content-Type: application/json \
Content-Length: 34
Location:
/members/100

{
   "username": "young",
   "age": 20

}

POST처리에 정해진 것이 없다 -> 리소스 URI에 POST 요청이 오면 요청 데이터틑 어떻게 처리할지 리소스마다 따로 정해야 한다

 

주로, 다음과 같은 경우에 많이 사용한다.

  1. 새 리소스 생성(등록)
  2. 요청 데이터 처리
  3. 다른 메서드로 처리하기 애매한 경우

put

  • 리소스 대체(있으면 대체 : 전체 삭제후 생성 / 없으면 생성)
  • 클라이언트가 리소스를 식별(URI 지정)
request
/members/100
(1) 생성
PUT /members/100 HTTP/1.1
Content-Type: application/json

{
   "username": "young",
   "age": 20
}

(2) 리소스 완전 대체
PUT /members/100 HTTP/1.1
Content-Type: application/json

{
   // username 없음
   "age": 50
}
(1) 생성
{
   "username": "young",
   "age": 20
}



(2) 리소스 완전 대체
{
   // username 삭제
   "age": 50
}


patch

  • 리소스 부분 변경 (put과의 차이)
request
/members/100
 
PATCH /members/100 HTTP/1.1
Content-Type: application/json

{
   // username 없음
   "age": 50
}


{
   "username": "young",
   "age": 20
}

 리소스 부분 변경

{
   "username": "young",
   "age": 50
}

delete

request
/members/100 리소스 제거
DELETE /members/100 HTTP/1.1
Host: localhost:8080
 
x

 

HTTP 메서드의 속성

안전(Safe Methods)

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

멱등(Idempotent Methods)

  • 한번 호출하든 두번 호출하든 결과가 똑같다.
  • GET, PUT, DELETE (POST x)
  • 자동 복구 메커니즘에 활용 가능 : 서버 Time out 등르로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시해도 되는가? 판단 근거, 멱등은 외부 요인으로 중간에 리소스가 변경되는 것까지는 고려하지 않는다

캐시가능(Cacheable Methods)

  • 응답 결과 리소스를 캐시해서 사용해도 되는가?
  • GET, HEAD, POST, PATCH 캐시가능
  • 실제로는 GET, HEAD 정도만 캐시로 사용, POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않음

HTTP웹_기본지식_20201226 출처: https://ko.wikipedia.org/wiki/HTTP

'HTTP' 카테고리의 다른 글

HTTP 상태코드  (0) 2022.03.13
HTTP 메서드 활용  (0) 2022.03.06
HTTP 기본  (0) 2022.03.01
URI와 웹 브라우저 요청 흐름  (0) 2022.02.24
인터넷 네트워크  (0) 2022.02.15

+ Recent posts