Api Design
コミュニティ/Api Designについて
このスキルは、REST APIの設計とレビューのための実績のあるパターンをアシスタントに提供します。リソースの命名方法やURLの構造、使用すべきHTTPメソッドとステータスコード、成功およびエラーレスポンスのフォーマット方法、そしてエンドポイント全体でページネーション、フィルタリング、ソート、検索をどのように一貫して処理するかを網羅しています。
プロジェクトの公開情報をもとに AI で作成した掲載ページです。誤りを含む場合があるため、元の情報源をご確認ください。
/Api Designの使いどころ
新しいREST APIのエンドポイントを設計する
既存のAPIエンドポイントを名前やステータスコードの誤りがないかレビューする
リストエンドポイントにページネーションとフィルタリングを追加する
APIの一貫したエラーレスポンス形式を設定する
パブリックAPIのバージョン管理戦略を計画する