아카이브

[API] REST - 표현을 통한 자원에 대한 조작: HTTP Method 본문

Backend

[API] REST - 표현을 통한 자원에 대한 조작: HTTP Method

Rayi 2024. 8. 1. 10:12

표현을 통한 자원에 대한 조작 (manipulation of resources through representations)

URI가 자원을 명시하는 부분이라면, HTTP Method는 그 자원을 어떻게 할 것인지에 대한 동작을 명시합니다.

따라서 API 요청은 동작을 담당하는 HTTP Methoddhk 자원을 담당하는 URI의 조합으로 이루어집니다.

 

아래에 대표적인 HTTP Method에 대해 정리하였습니다.

1. GET

자원을 가져옵니다. 가져오기만 할 뿐 자원 자체를 수정하지 않으므로 안전한 메소드라고 할 수 있습니다.

요청시 json 형식의 자원과 상태코드 200 OK를 반환합니다.

GET /members

2. POST

자원을 추가합니다. 요청시 json 형식의 자원과 상태코드 201 Created를 반환합니다.

POST /members
{
	"name" : "John"
}

3. PUT

자원을 교체합니다. 교체이기 때문에 원래 자원이 가지고 있던 속성 중 PUT에서 명시하지 않은 속성은 null 처리가 됩니다.

요청시 json 형식의 자원과 상태코드 200 OK를 반환합니다.

PUT /members/1
{
    "username": "mike"
}

# response
200 OK
{
    "username": "mike",
    "age": null
}

4. PATCH

자원을 수정합니다. PUT과는 달리 원래 자원이 가지고 있던 속성 중 PATCH에 명시되지 않는 속성이 있더라고 원래 속성값을 유지합니다.

요청시 json 형식의 자원과 상태코드 200 OK를 반환합니다.

PATCH /members/1
{
    "username": "mike"
}

# response
200 OK
{
    "username": "mike",
    "age": 26
}

5. DELETE

자원을 삭제합니다. 요청시 상태코드 204 No Content를 반환합니다.

DELETE /members/1

 

728x90

'Backend' 카테고리의 다른 글

[API] REST - 자기 서술적 메시지  (0) 2024.08.01
상태코드 정리  (0) 2024.08.01
[API] REST - 자원에 대한 식별: URI 표기법  (0) 2024.08.01
[API] REST API에 대해서  (0) 2024.07.30
[API] API에 대해서  (0) 2024.07.30
Comments