スキル: API Design

トリガー

/design api [API名またはエンドポイントの説明]

説明

TypeScriptインターフェース、リクエスト/レスポンススキーマ、エラーハンドリングを使用してAPIエンドポイントを設計します。

入力

• description: string、APIが実行すべき内容(必須)

プロセス

1. 既存のAPIコントラクトと設計ドキュメントを読み込む
2. REST規約に従ってAPIエンドポイントを設計する(プロジェクトがGraphQLを使用する場合はGraphQL)
3. リクエスト型とレスポンス型のTypeScriptインターフェースを定義する
4. エラーレスポンス形式とHTTPステータスコードを定義する
5. エンドポイントごとの認証と認可要件をドキュメント化する
6. レート制限とページネーションのニーズを特定する
7. APIコントラクトドキュメントを作成する
8. アプリケーションセキュリティレビューのための新しい攻撃面を導入するエンドポイントにフラグを立てる

出力

TypeScriptインターフェース、エンドポイント定義、セキュリティ要件を含むAPIコントラクトドキュメント。

自律性

• Tier 1: APIコントラクトの下書き
• Tier 2: APIが既存の承

...