REST API를 설계 할 때, 도움이 되도록 POST와 PUT을 차이를 알아보자.

흔히들 POST는 자원을 생성하고, PUT은 생성 혹은 갱신하는 것이 라고 한다. 결국 둘 다 자원을 생성하는 거라면, POST와 PUT의 차이는 무엇인지 알아보자.

HTTP POST에 대해

POST의 정의

• Request(요청)에 포함된 Entity(Http body에 해당)을 Request-URI에 정의된 리소스의 하위(Suboridiate) Entity로 새롭게 생성하는 요청을 서버에 보낼때 사용되는 Http Method이다.

따라서 Request-URI는 리소스의 Entity를 나타내는 Collection URI여야 한다.

예를 들어, 신발들의 정보를 저장하는 shoes가 있다.
그리고 각 신발의 정보들은 shoes라는 큰 카테고리 밑에 하위 item으로 등록되고 저장될 것이다.

그렇다면, shoes는 신발들이 모인 Collection이다.
이걸 URI로 적용해본다면 신발 정보의 Collection-URI는 /shoes가 된다.

POST는 /shoes라는 collection URI의 하위에 새로운 신발(Entity)을 Create(생성)할 때 사용되는 Http Method라고 할 수 있다.

POST의 특징

• POST Request는 Idempotent(멱등) 하지 않다
  Idempotent(멱등) 하지 않다 = 여러번의 재시도에 대한 모든 결과값이 동일하지 않다는 것이다.
  즉, POST로 동일한 entity의 Request를 N번 보낸다면, N개의 다른 리소스들이 생성되는 것이다.

• POST Request의 Response는 Caching 가능 하다
  POST request는 Cache-Control or Expires가 Http header 올바르게 정의되어 있다면 Response(응답) 값을 캐싱해도 된다. 대신 Response를 캐시로 응답 했다면, HTTP 300 으로 해당 응답이 캐시에서 왔다는 것을 표시해줘야 한다.

HTTP PUT에 대해

PUT의 정의

• Request-URI에 있는 Resource가 존재한다면, Request에 있는 Entity에 값으로 리소스를 Update(갱신)한다.

만약 Resource가 존재하지 않고, Request-URI와 Resource-URI가 올바르다면 리소스를 Create(생성) 할 때 사용되는 Http Method이다.

if resource 존재 -> Update(갱신)
else -> Create(생성)

PUT의 특징

• Resource Identifier
  PUT은 기존의 /shoes라는 collection URI에 더하여,/shoes/{shoe_id}로 해당 resource의 Resource Identifier를 나타내줘야 한다.

• PUT Request는 Idempotent(멱등)하다
  PUT request로는 새로운 정보가 계속되서 생성되지 않는다. 여러번 재시도를 하더라도, 동일한 결과 값을 받는다. 즉, PUT request는 idempotent(멱등) 하다.

• POST Request의 Response는 Caching 할 수 없다
  PUT request는 idempotent하다. 하지만 Response(응답) 값을 캐싱하면 안된다.

POST & PUT 예시

POST /shoes
= Http Body에 있는 정보로 새로운 Shoe 하위 Resource 생성

PUT /shoes/{존재하는_SHOE_ID}
= 존재하는_SHOE_ID에 존재하던 정보를 Overwrite(덮어쓰기)해서 정보를 갱신

PUT /shoes/{존재하지_않는_SHOE_ID}
= 존재하지_않는_SHOE_ID로 새로운 Resource 생성

POST & PUT 비교

	POST	PUT
Resouce identifier 유무	x	o
Idempotent(멱등) 한가?	x	o
Response를 Caching 해도 되는가?	o (대신 300으로 표시)	x

결론

POST의 경우 요청 URI에 /Collection URI까지만 포함이 되지만,
PUT의 경우 Collection URI/{Resource Identifier}가 포함되어야 한다.

그리고 요청 값의 결과로 POST는 Idempotent(멱등)하지 않은, 각 요청마다 새로운 결과 값을 제공하며, PUT의 경우 멱등한 같은 결과 값을 제공한다.

만약 resource의 create(생성)을 위해 POST를 사용했다면, N개의 생성 요청에 N개의 resource가 생성될 것이다.

하지만 PUT을 resource의 create(생성)에 사용했다면, 요청 클라이언트는 생성할 resource의 resoure identifier을 지정해줘야 한다. 그리고 N개의 요청을 보내더라도, 하나의 resource만 생성된 채로 정보를 계속해서 덮어쓰게 될 것이다.

References

https://restfulapi.net/rest-put-vs-post/
https://www.keycdn.com/support/put-vs-post
(https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html
https://restfulapi.net/resource-naming/