MENU
カテゴリー

httpメソッドの「putとpatchの使い分け」について僕が理解したことを簡単にまとめておく

  • URLをコピーしました!
目次

はじめに

API設計をしていくなかで理解しておくべきことはたくさんあるが、
httpメソッドのputとpatchの使い分けについてきちんと理解していなかったので、
これについて僕が理解した内容をここに記しておく。

putとpatchの使い分けについて

putについて

putは送信するデータでもともとのリソースを完全に上書きするというものらしい。
putを和訳すると、「置く」という意味になる。
完全に上書きするときに使用するメソッドなので、リソースの一部だけを更新変更する際には、このメソッドを使用するのは適さないということになる。

完全に理解しているわけではないが、例で言うと、
S3バケットにアップロードされている画像を丸々と更新したいときとかっぽい。
まぁふつうにレコードをまるっと更新したいときに「put」は使用するらしい。

patchについて

patchもput同様に指定したリソースを更新するために使用するメソッド。
これを和訳してみると、「まだら」とか「継ぎ当て用の布」とか「〔1区画の〕土地、〔畑の〕1区画」とかそういう感じの意味になるらしい。
たしかに洋服とかで「パッチワーク」みたいな言葉があった気がするので、なんとなく理解できる。

要するに、リソースの1部分を更新変更するときにこの「patch」は使用することができる。

例を出すとするなら、
ユーザー情報編集画面で、ユーザーの情報の「メールアドレス」だけを変更したいとき、みたいなときにこのpatchメソッドは使用することになるっぽい。

おわり

簡単ではありますが、おわり。

よかったらシェアしてね!
  • URLをコピーしました!
目次