Apidogリクエストプロキシエージェントを適切なネットワーク環境を持つマシンにデプロイすることができます。これにより、Apidogクライアント、ウェブ、または共有ドキュメントからのAPIリクエストがこのエージェントを通じてターゲットのAPIにルーティングされます。この機能は、特に共有ドキュメント上でのAPIデバッグに役立ち、クロスオリジンリソース共有(CORS)の問題を解決するのに役立ちます。異なる環境が特定のネットワーク要件を持っている場合、ローカル環境からの直接デバッグが不可能なシナリオに最適です。前提条件:#
サーバーにインストールされたDocker(最低必要バージョン: 20.10.0、推奨バージョン: 20.10.13) リクエストプロキシエージェントのデプロイ:#
リクエストプロキシエージェントはチーム/組織レベルのリソースです。一度デプロイされると、チームや組織内のすべてのプロジェクトで使用できます。Dockerが有効なサーバーにエージェントをデプロイするには、以下のコマンドを実行します:docker pull apidog/apidog-request-proxy-agent && \
docker run --name apidog-request-proxy-agent \
-p 9159:9159 \
-d apidog/apidog-request-proxy-agent
デプロイ時に環境変数を使用して基本設定を行うことがで きます。必要に応じて以下のオプションを使用してください:| 環境変数 | 説明 | 例 |
|---|
| SOURCE_IP_WHITELIST | 許可されたソースIPのリスト(カンマ区切り) | -e SOURCE_IP_WHITELIST=134.34.4.3,123.333.33.0/24 |
| SOURCE_IP_BLACKLIST | ブロックされたソースIPのリスト(カンマ区切り) | -e SOURCE_IP_BLACKLIST=134.34.4.3,123.333.33.0/24 |
| DESTINATION_DOMAIN_WHITELIST | 許可されたターゲットドメイン名のリスト(カンマ区切り) | -e DESTINATION_DOMAIN_WHITELIST=xxx.yyy.com,*.yyy.com |
| DESTINATION_DOMAIN_BLACKLIST | ブロックされたターゲットドメイン名のリスト(カンマ区切り) | -e DESTINATION_DOMAIN_BLACKLIST=xxx.yyy.com,*.yyy.com |
| DESTINATION_IP_WHITELIST | 許可されたターゲットIPのリスト(カンマ区切り) | -e DESTINATION_IP_WHITELIST=134.34.4.3,123.333.33.0/24 |
| DESTINATION_IP_BLACKLIST | ブロックされたターゲットIPのリスト(カンマ区切り) | -e DESTINATION_IP_BLACKLIST=134.34.4.3,123.333.33.0/24 |
| ALLOW_PRIVATE_IP | 内部IPへのリクエストを許可するかどうか(ブール値、デフォルトはfalse) | -e ALLOW_PRIVATE_IP=false |
Apidogリクエストプロキシエージェントはオープンソースであり、ニーズに合わせてカスタマイズできます(例:カスタムヘッダーパラメータの追加)。ソースコードはこちらからアクセスできます。
Apidogにリクエストプロキシエージェントを追加する:#
Docker上でApidogリクエストプロキシエージェントが稼働したら、Apidogのチームリソースに追加できます。ポップアップウィンドウにサーバーのホスト情報(デフォルトポートは9159)を入力し、保存をクリックします。すると、Apidogが接続を試みます。接続に失敗した場合、通知が表示され、作成は許可されません。
接続に成功した場合、リクエストプロキシエージェントがチーム内で正常に作成されます。
エージェントがデプロイされ、Apidogで正常に接続されると、以下の用途で使用できます: