レスポンスの可視化

Apidogは、レスポンスデータを可視化するためのプログラム可能なアプローチを提供している。これにより、レスポンス情報を分かりやすい形で表示でき、チームメンバーが現在のAPIドキュメントをより明確に理解できるようになる。

1. カスタムスクリプトの追加

Apidogでは、前処理または後処理でカスタムスクリプトを追加できる。

2. 呼び出し方法

カスタムスクリプトでは、pm.visualizer.set()関数を使用して、レスポンスボディのVisualizeタブに可視化された結果を表示する。

コード例

後処理では、カスタムスクリプトを使用してレスポンスからリンクを抽出し、base64画像を生成できる。

pm.visualizer.set()

このメソッドは3つのパラメータを受け付ける：

templateパラメータ（必須）：

templateは必須パラメータで、Handlebarsが受け取るHTMLテンプレート文字列で、最終的に<body>の下にレンダリングされる。template内で外部CSSスタイルシートを読み込むための<link>や、サードパーティライブラリを読み込むための<script>を書くことができる。

dataパラメータ（オプション）：

Handlebarsのテンプレート文字列変数を置き換えるために使用されるオブジェクトを受け取る。

optionsパラメータ（オプション）：

optionsメソッドが受け取るoptionsパラメータと同じで、最初のパラメータで渡されたテンプレート文字列をHandlebarsがどのようにコンパイルするかを設定するために使用する。

pm.getData(cb: (err, data) => void)

このメソッドが受け取るパラメータは関数で、pm.visualizer.set()で渡したテンプレート文字列の2番目のパラメータのデータを取得できる。

error エラーメッセージ

data pm.visualizer.set()の2番目のパラメータを通じて渡されたデータ

TIP

テンプレート文字列内のwindowオブジェクトでWorkerやindexedDBを呼び出すことはできない。

レスポンスの可視化

1. カスタムスクリプトの追加#

2. 呼び出し方法#

コード例#

pm.visualizer.set()#

pm.getData(cb: (err, data) => void)#

1. カスタムスクリプトの追加

2. 呼び出し方法

コード例

pm.visualizer.set()

pm.getData(cb: (err, data) => void)