Chipstar Lightのメモ

• アプリケーション中のリソースが、URIで示せる
  • アドレスバーに入力すれば、そのリソースを参照できる
• ステートレスにすることで、スケーラビリティが向上
• 統一されたインターフェース
  • シンプルで一貫性のある設計
• HTTPプロトコルやブラウザなどの機能を最大限に活かせる
  • キャッシュとかハイパーリンクとかブックマークとか

cookieによるセッション維持を行わない
同じURLやパラメータの組み合わせからは、常に同じ結果が返される事が期待される
システムの状態やセッションに依存しない

HTTPメソッド	操作	API例	URI例
GET	リソースを取得する	顧客データを全て取得する	/api/customers
GET	リソースを取得する	Idと一致する顧客データを取得する	/api/customers/{id}
POST	リソースを新たに追加する	Idと一致する顧客データを更新する	/api/customers/{id}
PUT	リソースを更新する	顧客データを追加する	/api/customers
DELETE	リソースを削除する	Idと一致する顧客データを削除する	/api/customers/{id}

POSTは他のメソッドがうまく当てはまらないような「非標準の振る舞い」に使う事もある。

ステータスコード	意味	レスポンス例	レスポンスボディ
200 OK	リクエストが成功し、要求に応じてリソースがBodyに格納される	顧客データの取得・削除に成功した場合	対象となる顧客データが格納される
201 Created	リソースの作成に成功したことを表す。新しいURLは、ヘッダ「Location」に入る	顧客データの追加に成功した場合	追加した顧客データが格納される（ヘッダのLocationには、追加した顧客データを表すURLが格納される）
200 OK	リクエストが成功し、要求に応じてリソースがBodyに格納される	顧客データの更新に成功した場合	空
404 Not Found	リソースが見つからないことを表す	顧客データが存在しない場合	空
400 Bad Request	リクエストが不正であることを表す	リクエストに検証エラーが存在する場合	検証エラー情報が格納される
500 Internal Server Error	サーバ内部でエラーが発生したことを表す	メソッド内で例外が発生した場合	エラー情報が格納される

以下のような設定で、全てのキャッシュを破棄してしまうような事を強要しない

Cache-control: no-cache

第2回 RESTfulなAPIの設計を学ぼう
RESTアンチパターン
RESTfulとは