エンドポイントコンプライアンスチェック

INFO

セットアップ要件については、AI機能の使用開始を参照してください。

概要

AIを使用して、API設計ガイドラインに基づき、現在のAPIドキュメントに対してエンドポイントコンプライアンスチェックを実行できます。AIは包括的なレポートを生成し、APIドキュメントを改善して設計標準により適合させ、よりプロフェッショナルで一貫性があり、読みやすいものにするために役立ちます。

AIは複数の基準に基づいてエンドポイントを分析します。

基準	説明
命名規則	エンドポイントパス、パラメータ、フィールドが標準的な命名パターンに従っているかを確認します
ドキュメントの完全性	説明、例、制約が提供されているかを検証します
HTTPメソッドの使用	GET、POST、PUT、DELETEなどが適切に使用されていることを確認します
レスポンス構造	レスポンス形式とエラーハンドリングを検証します
セキュリティプラクティス	認証および認可の要件を確認します

エンドポイントコンプライアンスチェック機能には、任意のAPIドキュメントページの右上隅からアクセスできます。クリックするだけで、AI主導のエンドポイントコンプライアンスチェックを開始できます。

Endpoint compliance checkボタンをクリックすると、AIがAPI設計ガイドラインに基づいてAPIドキュメントを分析します。その後、各評価基準のスコアと、詳細な説明および改善提案が提供されます。