コピーしたURLをブラウザで開くと、ApidogのオンラインAPIドキュメントが表示されます。
各APIはページとして表示され、以下のセクションが含まれます:メタデータ#
このセクションでは、URL、メソッド、更新時間、説明など、APIに関する基本的な情報が表示されます。ドキュメント作成時に表示するフィールドを選択できます。APIステータス
「Released」ステータスのAPIはステータスタグを表示しませんが、「Developing」などの他のステータスのAPIはAPI名の後にステータスタグが表示されます。「Deprecated」ステータスのAPIは左側のディレクトリツリーで「API名」として表示されます。
API説明
API説明に含まれるMarkdownは、メタデータの最後に表示されます。
デバッグ#
クリックすると「デバッグ」レイヤーが展開され、リクエストを送信したりパラメータを変更したり、リクエストの環境を切り替えたりできます。ここで利用可能な環境は、ドキュメント作成時に選択されたものです。ドキュメント作成時にCloud mock環境を選択した場合、ドキュメントの閲覧者に対して簡易的なサンドボックス環境を有効にすることと同等です。
リクエストを送信した後、ページ上でレスポンスと実際のリクエストを確認できます。変数の使用#
仕様のリクエスト例で{{variables}}
が使用されている場合、「デバッグ」機能を使用する際、閲覧者はまずこれらの変数に値を設定する必要があります。リクエスト#
パラメータとボディの仕様。Apidogは2つのパラメータ表示スタイルをサポートしており、プロジェクト設定 - 機能設定 - API機能設定でModernまたはClassicスタイルを選択できます。リクエストサンプル#
さまざまな言語でのリクエストサンプル。共有作成時にこのモジュールを表示するかどうかを選択できます。レスポンス#
レスポンス仕様とレスポンス例。Apidogクライアントと同じです。エクスポート#
ドキュメント作成時に「データのエクスポートを許可する」を選択した場合、閲覧者はドキュメントの右下と最下部にエクスポートオプションを表示します。閲覧者は「クローン」または「エクスポート」を選択できます。「エクスポート」はOAS、HTML、Markdown、Apidog形式でのエクスポートをサポートしています。