APIドキュメント完全性チェック

INFO

セットアップ要件については、AI機能の開始方法を参照してください。注: この機能には Apidog バージョン 2.7.55 以降 が必要です。

概要

AIを使用して、現在のAPIドキュメントに対して API Documentation Completeness Check を実行し、詳細なレビューレポートを生成できます。このレポートに基づいて、ドキュメントを調整および改善できます。これにより、コラボレーションがよりスムーズになり、ドキュメントが読みやすくなり、より正確なエンドポイント仕様によってすべてのAI機能がさらに効果的になります。

チェックされる内容

API Documentation Completeness Check を実行する前に、現在のAPIドキュメント内の説明と定義が完全であるかを確認しておくと役立ちます。このチェックでは、次の観点を分析します。

1. 基本定義

エンドポイントドキュメントが次の項目を明確かつ正確に指定しているかをチェックします。

要素	目的
リクエストメソッド	HTTPメソッド（GET、POST、PUT、DELETE）を定義し、リクエストのセマンティクス、冪等性、パラメータ構造を判断します
リクエストパス	エンドポイントを一意に識別し、パスパラメータ構造を推測するための完全なURLパス（ベースURLを除く）です
エンドポイント名と説明	読者およびAIがビジネスロジックを理解しやすくするための、エンドポイントの目的に関する短い説明です

2. パラメータの説明

エンドポイントドキュメントが次の項目を明確かつ正確に指定しているかをチェックします。

要素	目的
パラメータ名	パラメータ構造が完全であり、命名に一貫性があり、各パラメータが正しい場所（Params、Body、Headers、Cookies）にあることを確認します
例	一般的な値、形式、データ型、ビジネス上の意味を理解しやすくするために、有効なサンプル入力値を提供します
説明	パラメータの意味、目的、ビジネスシナリオを説明します

リクエストパラメータの基本情報は、AIの支援を受けて生成または変更できます。

3. パラメータ制約

エンドポイントドキュメントが次の項目を明確かつ正確に指定しているかをチェックします。

制約	目的
必須/Nullable	パラメータが必須かどうか、およびnull値が許可されるかどうかを示します
Enums/Const	使用可能な列挙値または定数値と、その意味を一覧表示します
境界値	最小値/最大値、長さ制限、その他の制約を提供します
形式	特殊な形式（date-time、email、uuid、binary、int64、json-string など）を説明します

4. レスポンス

APIドキュメントが次の項目を明確かつ正確に指定しているかをチェックします。

要素	目的
レスポンスボディ	レスポンスのコンテンツタイプ、フィールド説明、HTTPステータスコード、エラーコードについて完全な構造を提供します

レスポンスの基本情報も、AIの支援を受けて生成または変更できます。