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

AI機能について

AI関連機能を利用するには、手動でAI機能を有効化してください（Apidog バージョン 2.7.55 以降が必要です）。

ApidogのAI機能を利用するには、AIモデルキー（Claude、OpenAI、Gemini など）を追加・設定してください。ApidogのAI機能は無料です。ネイティブのAIモデルは提供しておらず、お客様自身のAIモデルのみを用いてデータを処理します。

現在のAPIドキュメントに対してAIで「APIドキュメント完全性チェック」を実行し、詳細なレビュー報告を生成できます。レポートをもとにドキュメントを磨き込むことで、コラボレーションはより円滑になり、可読性が向上します。あわせて、API仕様の精度が高まるため、各種AI機能の効果も向上します。

チェック対象

「APIドキュメント完全性チェック」を実行する前に、現行のAPIドキュメントにおける記述や定義が十分かを見直しておくと効果的です。以下の観点から確認を始めてください。

APIドキュメントに、次が明確かつ正確に示されているかを確認します。

リクエストメソッド：APIエンドポイントのHTTPメソッド（GET・POST・PUT・DELETE など）。リクエストの意味や冪等性、入力パラメータ構造の妥当性判断に必要です。

リクエストパス：ベースURLを除いた完全なURLパス。APIエンドポイントを一意に識別し、パスパラメータの構造を推測する土台になります。

エンドポイント名と説明：エンドポイントの目的を簡潔に示す説明。読者とAIの双方が業務ロジックを理解しやすくなり、パラメータ・レスポンス・エラーコードの完全性と妥当性を評価しやすくなります。

APIドキュメントに、次が明確かつ正確に示されているかを確認します。

パラメータ名（必要に応じて Params・Body・Headers・Cookies など）：パラメータ構造の完全性、命名の一貫性、正しい配置を確認するために必要です。

例：代表的な入力値や形式、データ型、業務上の意味を理解する助けとなる有効なサンプル。

説明：パラメータの意味・用途・想定シナリオの解説。

リクエストパラメータの基本情報は、AIの支援によって生成・修正できます。

APIドキュメントに、次が明確かつ正確に示されているかを確認します。

Required／Nullable：必須かどうか、Nullを許容するかの明示。必須欠落や不正なNullなど、テストシナリオの妥当性検証に不可欠です。

Enums／Const：取り得る列挙値や定数とその意味。値の正当性と網羅性を検証できます。

境界値：最小・最大、長さ上限などの制約。ドキュメントが意図する制約条件を正しく表現できているかを確認します。

format：date-time・email・uuid・binary・int64・json-string などの特別な形式。AIモデルが形式の適合性を正確に検証できるようにします。

APIドキュメントに、次が明確かつ正確に示されているかを確認します。

レスポンス本文：コンテンツタイプごとの完全な構造、各フィールドの説明、HTTPステータスコードおよびエラーコード。エンドポイントの出力が標準化され、欠落がなく、構造が一貫しているかをAIが判断できるようにします。

レスポンスの基本情報も、AIの支援で生成・修正できます。

APIのドキュメントページ右上に「APIドキュメント完全性チェック」機能があります。クリックしてチェックを開始します。

この機能がグレーアウトしている場合は、現在無効化されています。まずチームまたは組織の管理者が設定で有効化してください。あわせて、Apidogクライアントが最新バージョンであることを確認してください。

チェックを開始すると、AIが定義済みの基準に基づいて現行のAPIドキュメントをレビューします。各観点に対してスコア・解説・実行可能な改善提案を含む詳細レポートを生成し、不足点や改善方法をすばやく把握できるよう支援します。