コピーしたURLをブラウザで開くと、ApidogのオンラインAPIドキュメントが表示されます。
各APIはページとして表示され、以下のセクションが含まれます：メタデータ#
このセクションでは、URL、メソッド、更新時間、説明など、APIに関する基本的な情報が表示されます。ドキュメント作成時に表示するフィールドを選択できます。APIステータス
「Released」ステータスのAPIはステータスタグを表示しませんが、「Developing」などの他のステータスのAPIはAPI名の後にステータスタグが表示されます。「Deprecated」ステータスのAPIは左側のディレクトリツリーで「API名」として表示されます。
API説明
API説明に含まれるMarkdownは、メタデータの最後に表示されます。
デバッグ#
クリックすると「デバッグ」レイヤーが展開され、リクエストを送信したりパラメータを変更したり、リクエストの環境を切り替えたりできます。ここで利用可能な環境は、ドキュメント作成時に選択されたものです。ドキュメント作成時にCloud mock環境を選択した場合、ドキュメントの閲覧者に対して簡易的なサンドボックス環境を有効にすることと同等です。
変数の使用#
仕様のリクエスト例で{{variables}}が使用されている場合、「デバッグ」機能を使用する際、閲覧者はまずこれらの変数に値を設定する必要があります。認証情報の使用#
プロジェクトの認証設定で、API 単位またはフォルダー単位で認証を構成できます。Security Schemeを利用するか、手動で設定を定義できます。認証設定（例：Bearer Token 認証）を構成すると、「ドキュメント公開」パネルの上部に「認証情報」セクションが表示され、そこでトークン値を直接入力できます。この方式の主な利点は、認証情報を異なる API 間で共有できる点です。複数の API が同一の Security Scheme または認証方式を参照している場合、認証情報は一度入力するだけで、他の API でも自動的に再利用されます。これらの認証情報は暗号化されてブラウザーの LocalStorage に保存され、ブラウザーのセッションに基づいて管理されます。同一セッション内であれば、複数のウィンドウやタブで共有できます。ブラウザーを閉じてセッションが終了すると、これらの認証情報は自動的に無効になります。もう少し具体的に説明すると、LocalStorage に保存される認証情報は暗号化され、復号鍵はセッションクッキーに保存されます。LocalStorage のデータは長期的に残りますが、セッションクッキー内の復号鍵はブラウザーを閉じると失効します。その結果、暗号化されたデータは復号・参照できなくなり、次回アクセス時には認証情報を再入力する必要があります。リクエスト#
パラメータとボディの仕様。Apidogは2つのパラメータ表示スタイルをサポートしており、設定 - 機能設定 - エンドポイント機能設定でModernまたはClassicスタイルを選択できます。リクエストサンプル#
さまざまな言語でのリクエストサンプル。共有作成時にこのモジュールを表示するかどうかを選択できます。レスポンス#
レスポンス仕様とレスポンス例。Apidogクライアントと同じです。エクスポート#
ドキュメント作成時に「データのエクスポートを許可する」を選択した場合、閲覧者はドキュメントの右下と最下部にエクスポートオプションを表示します。閲覧者は「クローン」または「エクスポート」を選択できます。「エクスポート」はOAS、HTML、Markdown、Apidog形式でのエクスポートをサポートしています。 