- 致命的
- スタイル
- バージョン
- 判断が必要
すぐに答え
AIを使ってAPI設計をチェックするには?
AIが validate_api_design ツールを使用して、仕様書のメソッド使用法、バージョニングのロジック、レスポンス構造に誤りがないかスキャンします。設計が業界標準から逸脱している箇所を明確なレポートとして受け取れます。
検出された問題の分類
監査結果の分類
AIは、設計上の欠陥の深刻度や種類に基づいて、すべての検出結果を特定のカテゴリに分類します。
致命的
コントラクト違反
クライアント側の連携を壊してしまうような構造的な欠陥を特定します。バリデーションに失敗した具体的なパスのリストが提供されます。
スタイル
メソッドと命名規則
不整合なHTTPメソッドや非標準的な命名規則を指摘します。これにより、開発者にとって直感的なAPIになります。
バージョン
バージョニングの不一致
すべてのエンドポイントに対して、バージョニング戦略が一貫して適用されているかを確認します。ロジックの欠落や不備を特定します。
判断が必要
手動での設計判断
人間の判断を必要とする曖昧なパターンを指摘します。特定の設計が意図的なものか、あるいはミスかをユーザー自身が判断します。
ワークフロー
仕様書が届いた際、AIが行うこと
AIは厳格なテクニカルレビュアーとして機能し、特定の検証シーケンスに従って設計を精査します。
仕様書の解析
エージェントがOpenAPIやJSON schemaを読み取り、エンドポイントの全構造を把握します。
validate_api_designHTTPメソッドの確認
リソース作成にGETではなくPOSTを使用するなど、意図したアクションに対して正しい動詞が使われているかを検証します。
validate_api_designレスポンス構造の監査
定義されたレスポンスボディを業界の標準的なパターンと比較し、一貫性を確保します。
validate_api_designバージョニングの検証
バージョニングヘッダーやURLパスが、論理的かつ一貫したパターンに従っているかを確認します。
validate_api_design
試してみる
以下のプロンプトをコピーして開始
これらのプロンプトを使用して、検証プロセスを開始できます。
出発点
括弧内のテキストを、実際のファイルパスやリポジトリのリンクに書き換えて使用してください。
API Design Prover Connector
準備完了です。MCPクライアントを選択し、セットアップ手順に従ってください。
https://edge.vinkius.com/vk_preview_qg8XbvSmxEnaSpHzTf8C0mUG7OY2r5bZJfEFviZ0/mcpClaude Desktop
以下の手順で数秒で接続できます。
- 1In Claude Desktop, open Settings → Connectors.
- 2Click “Add custom connector” and paste the connector link above as the remote MCP server URL.
- 3Click Add and start a new chat — API Design Prover capabilities are ready to use.
{
"mcpServers": {
"api-design-prover-mcp": {
"url": "https://edge.vinkius.com/vk_preview_qg8XbvSmxEnaSpHzTf8C0mUG7OY2r5bZJfEFviZ0/mcp"
}
}
}ローカルファイル ./specs/v1/auth.yaml にあるAPI設計を検証してください。
GitHubリポジトリ内のユーザー管理エンドポイントの設計をチェックしてください。
現在のワークスペースにあるサービス定義に対して、コントラクト検証を実行してください。
この仕様書におけるAPI設計は、標準的なRESTfulのメソッドパターンに従っていますか?
Claude
ChatGPT
Cursor
VS Code
Windsurf
Claude Code
JetBrains
Cline
ここから始める
API Design Proverを接続すれば、あとは指示するだけ
MCPをお好みのクライアントにリンクさせるだけです。認証情報は暗号化されて保持されるため、すぐに仕様書の監査を開始できます。
API Design ProverをAIに接続するFAQ
動作について
- 01
AIがAPI設計を自動的に修正することはできますか?
いいえ。AIは判定を下し、エラーを特定しますが、仕様書ファイルの更新は手動で行う必要があります。
- 02
あらゆるAPI形式に対応していますか?
OpenAPIやJSON schemaなどの標準的なRESTful仕様向けに設計されています。
- 03
AIがファイルを書き換えることはありますか?
いいえ。このツールは検証のためにファイルを読み取るだけで、コードを書き換えたり上書きしたりすることはありません。
- 04
CursorやClaudeで使用できますか?
はい。MCPに対応しているクライアントであれば、このコネクターを使用できます。
- 05
セキュリティの脆弱性もチェックしてくれますか?
いいえ。このツールは設計標準、メソッドの使用法、レスポンス構造に特化しており、セキュリティ診断やペネトレーションテストを行うものではありません。
API Design Proverについてさらに詳しく知りたいですか? API Design Prover Connectorの全機能を見る
『API Design Prover』を Claude、Cursor、ChatGPT などに接続
