Apidog の公開 API ドキュメントは、API をインタラクティブかつ包括的に表示します。ユーザーがドキュメント URL にアクセスすると、各エンドポイントが理解とテストを容易にする複数のセクションで構成された、整理された形式で表示されます。ドキュメント構成#
各エンドポイントページには、次のセクションが含まれます。メタデータ#
このセクションには、URL、HTTP メソッド、変更日時、説明などの基本的なエンドポイント情報が表示されます。ドキュメントを作成する際に、表示するフィールドを選択できます。エンドポイントのステータス#
「Released」ステータスのエンドポイントにはステータスタグは表示されません。「Developing」など、その他のステータスのエンドポイントで は、エンドポイント名の後にステータスタグが表示されます。「Deprecated」ステータスのエンドポイントは、左側のディレクトリツリーに「エンドポイント名」として表示されます。エンドポイントの説明#
エンドポイントの説明に含まれる Markdown コンテンツはレンダリングされ、メタデータセクションの末尾に表示されます。試してみる#
「試してみる」をクリックすると、インタラクティブなテストレイヤーが展開 され、リクエストの送信、パラメータの変更、環境の切り替えを行えます。利用可能な環境は、ドキュメント作成時に選択した環境です。ドキュメント作成時に Cloud mock 環境を選択すると、読者に API テスト用のシンプルなサンドボックス環境を提供できます。 変数の使用#
リクエスト例で {{variables}} が使用されている場合、読者はリクエストを送信する前に変数値を設定する必要があります。認証情報の使用#
プロジェクトの Auth 設定内で、API レベルまたはフォルダレベルの認証を設定できます。セキュリティスキームを使用するか、手動で設定を定義します。認証設定を構成した後、たとえば Bearer Token 認証を使用する場合、「Publish Documentation」パネル上部に「Credentials」セクションが表示され、トークン値を直接入力できます。この設定方法の主な利点は、認証情報を複数の API 間で共有できることです。複数の API が同じセキュリティスキームまたは認証タイプを参照している場合、認証情報を一度入力するだけで、他の API が自動的に再利用できます。これらの認証情報は暗号化されてブラウザの LocalStorage に保存され、ブラウザセッションに基づいて管理されます。同じセッション内では、複数のウィンドウやタブ間で共有できます。ブラウザを閉じてセッションが終了すると、これらの認証情報は自動的に無効になります。より具体的には、LocalStorage に保存される認証情報は暗号化されており、復号キーはセッション Cookie に保存されます。LocalStorage 内のデータは長期間保持されますが、セッション Cookie 内の復号キーはブラウザを閉じるとすぐに期限切れになります。その結果、暗号化されたデータは復号またはアクセスできなくなり、次回アクセス時には認証情報を再入力する必要があります。リクエスト#
このセクションには、パラメータとボディの仕様が表示されます。Apidog は、Modern または Classic の 2 種類のパラメータ表示スタイルをサポートしており、Settings → Feature Settings → Endpoint Feature Settings で選択できます。リクエストサンプル#
さまざまなプログラミング言語のリクエストコードサンプルです。共有を作成する際に、このモジュールを表示するかどうかを選択できます。レスポンス#
レスポンスの仕様と例が、Apidog クライアントと同じ形式で表示されます。エクスポート#
ドキュメント作成時に「Allow exporting data」を選択した場合、読者には右下隅およびドキュメントの最下部にエクスポートオプションが表示されます。読者は「Clone」または「Export」を選択できます。「Export」は、OAS、HTML、Markdown、Apidog 形式でのエクスポートをサポートしています。 Modified at 2026-06-11 07:06:02
