API リクエストの送信に成功すると、Apidog はリクエストとレスポンスのデータを自動的に解析し、完全なエンドポイント仕様を作成できます。この強力な機能により時間を節約でき、API ドキュメントが実際の動作を正確に反映していることを保証できます。リクエストをエンドポイント仕様に解析する#
正常に送信されたリクエストがまだ定義されていない場合、Apidog によってエンドポイント仕 様として自動的に解析できます。リクエストを送信した後、Save ボタンの横にあるドロップダウンをクリックし、Save as endpoint を選択して、エンドポイント仕様として保存できます。リクエストをエンドポイントとして保存すると、Apidog は次の情報をインテリジェントに抽出します。リクエストパラメータ: 現在のリクエストのリクエスト params のタイプは、エンドポイント内のリクエストパラメータ仕様として扱われ、現在のパラメータ値はリクエストパラメータの例の値として扱われます。
レスポンススキーマ: 現在のリクエストのレスポンスデータ構造はレスポンス仕様として解析され、レスポンス値はレスポンス例として扱われます。
この機能は、既存の API を扱う場合や、スキーマを手動で定義するのではなく、実際のリクエスト/レスポンスデータに基づいて API をすばやくドキュメント化したい場合に特に役立ちます。
レスポンスを抽出する#
Apidog は、レスポンスをエンドポイント仕様に抽出することをサポートしており、レスポンススキーマ または レスポンス例 として抽出できます。この柔軟性により、エンドポイントのスキーマ定義を更新するか、ドキュメント化およびテストの目的で新しいレスポンス例を追加するだけにするかを選択できます。レスポンスをスキーマとして抽出することは API 構造が変更された場合に役立ち、例として抽出することはさまざまなレスポンスシナリオ（成功、エラー、エッジケース）をドキュメント化する場合に適しています。
