RESTful API

RESTful API は REST（Representational State Transfer）アーキテクチャスタイルに基(もと) づいて設計(せっけい) された API で、HTTP メソッドを使用(しよう) してリソースを操作(そうさ) する。

HTTP Methods

Method	Idempotent	Safe	用途(ようと)
GET	Yes	Yes	リソース取得(しゅとく)
POST	No	No	新規(しんき) リソース作成(さくせい)
PUT	Yes	Yes	リソース完全(かんぜん) 更新(こうしん)
PATCH	No	No	リソース部分(ぶぶん) 更新(こうしん)
DELETE	Yes	Yes	リソース削除(さくじょ)

GET メソッドはサーバーからリソースを取得(しゅとく) するために使用(しよう) 。リソースの状態(じょうたい) を変更(へんこう) しないため、安全(あんぜん) なメソッドと言(い) える。

POST はサーバー上(じょう) のリソースコレクションに新(あたら) しいリソースを作成(さくせい) するために使用(しよう) 。

PUT はサーバー上(じょう) の既存(きそん) リソースを更新(こうしん) し、リソース全体(ぜんたい) を置換(ちかん) する。

PATCH はサーバー上(じょう) の既存(きそん) リソースの一部(いちぶ) を更新(こうしん) するために使用(しよう) 。

DELETE はサーバーからリソースを削除(さくじょ) する。Request-URI で識別(しきべつ) されたリソースを削除(さくじょ) 。

同(おな) じリクエストを 1 回(かい) 実行(じっこう) しても複数回(ふくすうかい) 実行(じっこう) しても効果(こうか) が同(おな) じであること。サーバーの状態(じょうたい) も同(おな) じ。冪等(べきとう) メソッドには副作用(ふくさよう) がないべき。