show log include yunabe

勉強したことの復習を兼ねて、IT関係についてまとめてます。

API試験ツール"Postman"の紹介

概要

APIを試しに叩いてみたいときやAPIを作成し、実際に想定通りの動きをするか確認するツールとして"Postman"を紹介します。
今回は試しにAPIを叩く際にPostで認証のためのトークンを取得し、Get メソッドを叩き、返ってきたAPIのKey情報が想定通りチェックする動作をシナリオにしたいと思います。

APIを叩く環境の準備をする

右上の⚙(歯車マーク)をするクリックし、MANAGE ENVILOMENTS を選択する。
add で今回の環境を作ります。
ここで宣言した変数は、この環境内で{{ baseURI }}等で呼び出すことができます。
keyとvalueを入力する欄があるので今回は認証トークンを入れるため、以下のkeyを用意します。
・accessToken(POSTで認証トークンを入れるために用意します)
・baseURI(base URI を試験するのであれば変数化しとくと便利です)

access token から認証キーを取得する

Body

まず初めにユーザ認証をするために認証サーバにPOSTを行います。

{
  "grantType":"client_credentials",
  "clientId":"client_id",
  "clientSecret":"client_ecret"
}

Tests

取得したAPIトークンを変数に入れます。

var jsonData = JSON.parse(responseBody);
tests["tokenType"] = jsonData.tokenType === "BearerToken";
postman.setEnvironmentVariable("accessToken", jsonData.accessToken);

応答のあったAPIの値をテストする

以下ではHTTPレスポンスコードが200であることと、返ってきたJSONの key に"body_key"が含まれていることを確認する試験を記載しています。

var jsonData = JSON.parse(responseBody);
tests["StatusCode200"] = responseCode.code === 200;
tests["paramsBodyTitle"] = responseBody.has("body_key");

動作のシナリオ化

左上のRunnerボタンを押すと上記に一連の動作をシナリオとして実行することができます。

Enviroment

トークン情報を入れた変数の選択等の環境についての選択をします。

Interation

この一連の動作の試行回数を記入します、"2"とすると以下になります。
1.Post トークンを取得
2.Get API でリソースを取得
3.Put API でリソースを置換
1'.Post トークンを取得
2'.Get API でリソースを取得
3'.Put API でリソースを置換

Delay

一つの動作の時間感覚を"ms"で入力します。
1000ms = 1s なので1秒と勘違いしないように値を入力して下さい。

参考

https://www.getpostman.com/docs/