Explorer API テスト環境

Apigit テストツールの環境とは

Apigit の環境は、リクエストで使用できるさまざまな変数セットを作成および管理できる機能です。環境は、Apigit 内でアクセスおよび変更できるキーと値のペアのコレクションと考えることができます。

簡単に言えば、環境とは、API 要求で頻繁に使用される URL、アクセス トークン、その他の値などの変数を格納する方法です。これらの値を環境に保存することで、異なる構成を簡単に切り替えて、毎回値を手動で更新することなく、異なる環境に対して要求を実行できます。

Apigit の各環境は、ワークスペース内のすべてのリクエストからアクセスできるグローバル変数や、その環境内のリクエストでのみ使用できる環境固有の変数など、一連の変数で構成されています。変数は、手動で設定および更新するか、スクリプトまたは Apigit API を使用して動的に設定できます。

Apigit ワークスペース内に複数の環境を作成し、環境ドロップダウン メニューを使用して簡単に切り替えることができます。これにより、毎回リクエストを手動で更新することなく、開発、ステージング、本番などのさまざまな環境に対して API を簡単にテストできます。

最初の環境セットを作成する

API をデバッグするとき、ローカル環境、開発環境、および本番環境の間を行き来する必要があることがよくあります。また、期限切れのトークンなどの問題にも直面しており、イライラする可能性があります。一部のチュートリアルでは、Apigit を使用してプロセスを簡素化することを提案していますが、実際には、まだいくつかの問題が発生する可能性があります。そのため、この詳細なブログ投稿では、API をシームレスにデバッグするときに異なる環境を切り替える手順を簡素化するために、Apigit の環境の使用を紹介します。

グローバル データ環境を使用する手順:

テスト ケース ファイルを編集するには、次の場所に移動します。Test Cases リポジトリ内で適切なファイルを選択します。デフォルトの表示モードで、サイドバーの左下隅にある ✏️ アイコンをクリックします。

環境セットを追加または編集するには、Env トップバーの中央にあるボタン。そこから、環境設定にアクセスして、必要な変更を加えることができます。

切り替えるオプションがありますCode とForm ページの右上隅にある対応するボタンをクリックして、モードを表示します。

のCode モード：

[
  {
    "type": "code",
    "description": "initialization",
    "parameters": {
      "code": "var baseUrl = env.get(\"baseUrl\");\nvar test = env.get(\"username\");\nif (test == null){\n    fail(\"test is null\");\n}\nif (baseUrl == null) {\n    state.baseUrl = \"http://petstore.mock.apigit.com\";\n    //env.set(\"baseUrl\", \"http://petstore.mock.apigit.com\")\n}\nstate.test = test;\n"
    }
  },
  {
    "type": "http",
    "description": "get pet inventories by username",
    "parameters": {
      "method": "get",
      "url": "{baseUrl}/store/inventory/{test}",
      "query": [],
      "auth": {
        "type": "{test}"
      },
      "header": [],
      "body": {
        "type": "none",
        "data": ""
      },
      "postTest": "if (!res || res.status !== 200) {\n    fail(\"get pet inventory failed\")\n}"
    }
  }
]

のForm モード：

環境データを使用するには、コードを追加できますCode Execution Action またTest のセクションHttp Request Action.

の使用に注意してくださいvar 独自のセクションに限定されます。次のような変数を定義すると、test、セクション内Code Execution Action 内で使用したいHTTP Request Action セクション、使用する必要がありますstate.test 変数にアクセスします。