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

環境の管理

同じプロジェクトは、異なる段階で異なる環境（開発、テスト、本番など）で行われる必要があります。通常、環境が変わると、そのベースURL、APIのパラメータ値も変わります。環境の変更とともに、ベースURLとパラメータを頻繁に更新するのは非常に面倒くさいことです。Apidogの環境管理機能を使用すると、環境ごとに異なるベースURLとパラメータ値を設定すると、異なる環境の切り替えが非常に便利で、楽にテストを行えます。

環境のセットアップ​

環境管理機能はどこ？​

環境管理機能は、ソフト画面の右上隅にあります。環境管理のページにアクセスするには、以下に示すように、2つの方法があります。

apidog

環境管理のページ​

左側のメニューから環境を添削することができますが、右側のパネルで環境を編集することができます。

apidog

機能​

Base URL： Base URLは自動的にAPIパスの先頭に追加され、実際のRequestのURLが形成されます。たとえば、Base URLがhttps://www.api.comで、入力したパスが「/pets/123」の場合、実際のRequestのURLはhttps://www.api.com/pets/123になります。

環境変数：環境変数は、環境の変更に伴って変更した変数です。ここで環境変数/グローバル変数/ローカル変数の詳細を見る。

apidog

追加パラメータ：追加のパラメータは、特定の環境のすべてのAPIに自動的に追加されます。追加パラメータの値は、環境変数/グローバル変数/ローカル変数を参照できます。

ご案内：
  1. APIを設計するときは、Base URLの最後に/を追加せず、インタフェースパスの先頭に/を追加することをお勧めします。
  2. APIパスがhttp://、またはhttps://から始まる場合、Base URLは実際のRequestに追加されません。これはおすすめしない操作です。
ご案内：
  • システムには、BASE_URLという内蔵の特別環境変数があり、その値は現在の環境のBase URLです。{{BASE_URL}}からそれにアクセスできます。
  • BASE_URLと同じな名前の環境変数を手動で追加すると、システムに内蔵されているBASE_URLの値が上書きされます。
  • pm.environment.get('BASE_URL')のScriptからBase URLにアクセスできます。
  • ScriptはBase URLを変更できません。pm.environment.set('BASE_URL','xxx')というScript は、BASE_URLという名前の真実の環境変数を生成しますが、Base URL を変更しません。

環境を快速に切り替える​

ソフト画面の右上隅にあるドロップリストから、必要に応じて環境をすばやく切り替えることができます。

apidog

サービス (Base URL)​

通常の状況では、複数のサービスを追加することをおすすめしません。

同じ環境で複数のAPIが異なるBase URLを使用する場合にのみ、複数のサービスを追加する必要があります。このシナリオでは、各サービスのBase URLが異なり、異なるAPIまたはグループは異なるサービスを選択する必要があります。

apidog

サービスと環境との相違点​

利用シーン：

Environment

  Development Environment
  Debugging Environment
  Pre-release Environment
  Production Environment

Service

  User Service (user.xxx.com): Log in and other API
  Transaction Service(trade.xxx.com): Transaction-related Service
  Streaming Service (live.xxx.com): Streaming-related Service

サービスのセットアップ​

環境管理ページでBase URLを入力できます。

サービスの使用​

  1. グループ設定では、現在の環境（推奨）で異なるサービスを設定できます。

  2. APIドキュメント → 変更タブでは、現在の環境で異なるサービスを設定できます。