API スキーマの検証

概要

このスキルは、API スキーマ検証タスクの自動化された支援を提供します。 このスキルは、説明された機能の自動化された支援を提供します。

前提条件

このスキルを使用する前に、以下を確認してください:

• API 設計仕様または要件がドキュメント化されていること
• 必要なフレームワークがインストールされた開発環境があること
• データベースまたはバックエンドサービスが統合に利用可能であること
• 認証と認可戦略が定義されていること
• テストツールと環境が構成されていること

手順

1. Read ツールを使用して {baseDir}/api-specs/ から既存の API 仕様を確認します
2. リソースモデル、エンドポイント、HTTP メソッドを定義します
3. リクエスト/レスポンス スキーマとデータ型をドキュメント化します
4. 認証と認可の要件を特定します
5. エラーハンドリングと検証戦略を計画します
6. Bash(api:schema-*) とフレームワークのスキャフォルディングを使用してボイラープレートコードを生成します
7. ビジネスロジックを備えたエンドポイントハンドラーを実装します
8. 入力検証とスキーマの強制を追加します
9. 認証と認可ミドルウェアを統合します
10. データベース接続と ORM モデルを構成します
11. すべてのエンドポイントをカバーする統合テストを作成します

詳細な実装ガイドについては、{baseDir}/references/implementation.md を参照してください。

出力

• {baseDir}/src/routes/ - エンドポイントルート定義
• {baseDir}/src/controllers/ - ビジネスロジックハンドラー
• {baseDir}/src/models/ - データモデルとスキーマ
• {baseDir}/src/middleware/ - 認証、検証、ロギング
• {baseDir}/src/config/ - 構成と環境変数
• 完全なエンドポイント定義を含む OpenAPI 3.0 仕様

エラーハンドリング

包括的なエラーハンドリングについては、{baseDir}/references/errors.md を参照してください。

例

詳細な例については、{baseDir}/references/examples.md を参照してください。

リソース

• Node.js API 向けの Express.js と Fastify
• Python API 向けの Flask と FastAPI
• Java API 向けの Spring Boot
• Go API 向けの Gin と Echo
• API ドキュメント用の OpenAPI Specification 3.0 以上