API バッチ処理

概要

このスキルは、API バッチプロセッサのタスクに対する自動化されたサポートを提供します。 このスキルは、記載されている機能に対する自動化されたサポートを提供します。

前提条件

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

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

手順

1. Read ツールを使用して {baseDir}/api-specs/ から既存の API 仕様を確認します
2. リソースモデル、エンドポイント、HTTP メソッドを定義します
3. リクエスト/レスポンススキーマとデータ型をドキュメント化します
4. 認証・認可要件を特定します
5. エラーハンドリングと検証戦略を計画します
6. Bash(api:batch-*) でフレームワークのスキャフォルディングを使用してボイラープレートコードを生成します
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 を参照してください。

リソース

• Express.js および Fastify (Node.js API)
• Flask および FastAPI (Python API)
• Spring Boot (Java API)
• Gin および Echo (Go API)
• OpenAPI Specification 3.0+ (API ドキュメント)