『Web API の設計』 で紹介された REST API の設計方法
『Web API の設計』 で紹介された REST API の設計方法
4 つのステップ
各リソースとそれらの関係を特定する
アクション、パラメータ、戻り値を特定する
リソースのパスを設計する
パスの要件は一意であることのみ
デファクトスタンダードとしては、
/resources/{resource-id} の形式アクションを HTTP で表す
これらのステップに API のゴールキャンバスを利用できる
リソースのパスを設計し、アクションを表す HTTP メソッドを選択するときには OpenAPI Specification を利用できる
API のデータ設計
リソースを設計する
プロパティには、名前と型と必須かどうかの情報が必要
オプションで追加の説明も
データ設計においては、OpenAPI Specification 文書に JSON Schema で記述する
アクションリソースというような妥協点もある