メインコンテンツまでスキップ

オンラインドキュメントのデバッグ

本文では、リリース済みのオンラインドキュメンのデバッグを行う手順を紹介します。

デバッグ環境の選択​

前提：APIドキュメントを共有するには、実行環境を選択する必要があります。

APidog

そして、リリース済みのドキュメントに移動して、「Try it Out」機能を利用して、快適にRequestを送信できます。

APidog

環境変数の利用​

前提：APIドキュメントをオンラインで共有する時、変数が追加済みの環境を選択する必要があります。

APidog

環境変数を利用することで、ドキュメントでAPIのデバッグ効率をかなり向上できます。APIドキュメントで「環境変数」を直接に変更して、Requestを送信できます。

サンルプコードの利用​

APIオンラインドキュメントのコード生成機能を利用して、便利にAPIをデバッグしたりすることができます。

APidog

Run in Apidog リンクのURLの仕様説明​

1. リンクのURL​

WEBバージョンプロジェクトのアドレスhttps://app.apidog.com/project/{Project ID}
プロジェクト内でAPIを指定：APIタブhttps://app.apidog.com/project/{Project ID}/apis/api-{Interface ID}
プロジェクト内でAPIを指定：実行タブhttps://app.apidog.com/project/{Project ID}/apis/api-{Interface ID}-run
オンラインドキュメント (公開プロジェクト) ドキュメントのホームページhttps://www.apidog.com/apidoc/project-{Project ID}
ドキュメント内でAPIを指定https://www.apidog.com/apidoc/project-{Project ID}/api-{Interface ID}
ドキュメント内でAPIを指定：「実行」モジュールを自動的に開くhttps://www.apidog.com/apidoc/project-{Project ID}/api-{Interface ID}-run

環境変数を渡す​

機能：パラメータを渡すことで、ユーザーの実行時の「環境変数」を自動的に設定します。

使い方：URLのパラメータ environment[``変数名``]=``変数值を追加します。例：

WEBバージョンのプロジェクト：

オンラインドキュメント：

Requestパラメータを渡す​

機能：「実行」モジュールでAPIの「パラメータ」を設定します（プロジェクト内の指定されたAPIアドレスと実行タブにのみ適用されます）。

シンプルモード：

注：「シンプルモード」は、パラメータ名に角括弧を含むシナリオをサポートしていません。この場合、「高度モード」を使用してください。

パラメータのタイプパラメータ値メモ
Queryパラメータquery[xxx]=yyy
Pathパラメータpath[xxx]=yyy
Bodyパラメータbody[xxx]=yyyBodyタイプは：formdataかx-www-urlencodedのいずれかになります。
Bodyパラメータbody=yyy他のBodyタイプ
Headerパラメータheader[xxx]=yyy
Cookieパラメータcookie[xxx]=yyy
環境変数environment[xxx]=yyyデフォルト環境の環境変数に保存します。

高度モード

WEB 実行中のインターフェースで、URLを通してパラメータを渡す場合：

[https://www.apidog.com/project/406014/apis/api-10061199-run?params={ "query"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" }%2C "body"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" }%2C "cookie"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" }%2C "environment"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" } }](https://www.apidog.com/project/406014/apis/api-10061199-run?params={ "query"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" }%2C "body"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" }%2C "cookie"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" }%2C "environment"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" } })

params の値は下記のJSONデータでencodeURIComponentによって取得されました。

JSONデータ

{

    "query": [

        ["id", "value1"], 

        ["id", "value2"], 

        ["key2", "value3"]

    ],

    "path": [

        ["key1", "value1"], 

        ["key2", "value2"]

    ],

    "body": [

        ["aaa", "value1"], 

        ["key2", "value2"]

    ],

    "header": [

        ["testHeader", "value1"], 

        ["key2", "value2"]

    ], 

    "cookie": [

        ["testCookie", "value1"], 

        ["key2", "value2"]

    ], 

    "environment": [

        ["key1", "value1"], 

        ["key2", "value2"]

    ]

}
パラメータタイプパラメータ値メモ
Queryパラメータquery
Pathパラメータpath
BodyパラメータbodyBodyのタイプがformdataかx-www-urlencodedの場合、Bodyの値はJSONになります。そうでなければ、bodyの値は文字列（String）になります。
Headerパラメータheader
Cookieパラメータcookie
環境変数environmentデフォルト環境の環境変数に保存します。