プロキシの設定

開発プロキシには、プロキシの実行方法を制御するために使用できるいくつかの設定が用意されています。

これらの設定を構成するには、プロキシ インストール フォルダーにある devproxyrc.json ファイルで設定するか、実行時にコマンド ライン オプションを使用して設定します。

次の表に設定を示します。

設定 説明 コマンドライン オプション 使用できる値 規定値
apiAllowedOrigins 開発プロキシ API を呼び出すことができる正確なブラウザーの配信元。 すべての要求には、インスタンス ベアラー トークンが引き続き必要です。 該当なし パス、ワイルドカード、または末尾のスラッシュを含まない HTTP または HTTPS オリジンの配列 (例: ["http://127.0.0.1:3000"] []
apiIpAddress バインド先の Dev Proxy API の IP アドレス。 この設定は、 ipAddressとは無関係です。 ベアラー トークンは HTTP 経由で送信されるため、非ループバック アドレスは信頼されたネットワークでのみ使用します。 --api-ip-address <apiIpAddress> IPv4 または IPv6 アドレス 127.0.0.1
apiPort リッスンする認証済み開発プロキシ API のポート。 OS がランダムに使用可能なポートを割り当てできるようにするには、 0 に設定します。 --api-port <apiPort> 整数 8897
asSystemProxy 起動時に開発プロキシをシステム プロキシとして登録するかどうか。 trueに設定installCertが必要な場合は、次のように設定します。true --as-system-proxy true、false true
env 開発プロキシ プロセス用に設定する環境変数。 開発プロキシは、構成ファイルを読み込んだ後、プラグインを読み込む前に設定するため、環境変数を読み取るプラグインはこれらの値を使用します。 開発プロキシでは、MinimalPermissions プラグインによって使用される API 仕様ファイルのプレースホルダー {name} 置き換えるためにも使用されます。 --env渡された値は、構成ファイルの値を置き換えます。 HTTP_PROXY、HTTPS_PROXY、ALL_PROXY、またはNO_PROXY (小文字のバリアントを含む) を変更するには、キャッシュされた HTTP プロキシ設定をホット リロードで更新できないため、開発プロキシの停止と起動が必要です。 -e, --env <env> コマンド ライン上の文字列値を持つオブジェクト (例: {"CI": "1"};、1 つ以上のスペース区切りの name=value ペア) 該当なし
filterByHeaders 特定のヘッダーを持つ要求のみをインターセプトする 該当なし {"filterByHeaders": [ { "name": "value" } ] }。 値に関係なく、指定したヘッダーを持つ要求を含めるには、値を空にすることができます。 該当なし
installCert ルート証明書をインストールするかどうか --install-cert true、false true
ipAddress バインド先のプロキシの IP アドレス --ip-address <ipAddress> IPv4 アドレス 127.0.0.1
languageModel 言語モデルの設定 該当なし 詳細については、「 言語モデル 」セクションを参照してください。 該当なし
logLevel ログに記録するメッセージのレベル --log-level <loglevel> trace、debug、information、warning、error information
newVersionNotification 新しいバージョンについて通知するかどうか 該当なし none、stable、beta stable
noColor 色付きの出力を無効にする --no-color 該当なし 該当なし
noFirstRun 最初の実行エクスペリエンスをスキップする (macOS で証明書を信頼しない) --no-first-run 該当なし 該当なし
noWatch 構成ファイルが変更されたときにプロキシの自動再起動を無効にする --no-watch 該当なし 該当なし
output 構造化ログの出力形式 --output <format> text、json text
port リッスンするプロキシ サーバーのポート。 OS がランダムに使用可能なポートを割り当てできるようにするには、 0 に設定します。 -p, --port <port> 整数 8000
record このオプションを使用して、すべての要求ログを記録します --record 該当なし 該当なし
showSkipMessages 開発プロキシがプラグインの実行をスキップしたときにログ メッセージを表示するかどうか。 該当なし true、false true
showTimestamps 対話型ログ出力に要求タイムスタンプを表示するかどうか。 デタッチされたログ ファイルには常に完全なタイムスタンプが含まれているため、日付と時刻でフィルター処理できます。 該当なし true、false true
timeoutSeconds 開発プロキシが終了した後の時間 (秒)。 Dev Proxy が要求をインターセプトしたときにリセットします。 -t, --timeout <seconds> 正の整数 該当なし
urlsToWatch プロキシがインターセプトする URL の一覧 -u, --urls-to-watch <urlsToWatch> 絶対 URL (ワイルドカードを含めることができます) "https://api.contoso.com/*" devproxyrc ファイルを参照してください
validateSchemas 指定したスキーマに対して構成を検証するかどうかを指定します。 JSON 構成ファイルにのみ適用されます。 該当なし true、false true
watchPids 要求を監視するプロセスの ID --watch-pids <pids> 整数の配列。コマンド ラインで、1 つ以上のスペース区切り整数 該当なし
watchProcessNames 要求を監視するプロセスの名前 --watch-process-names <processNames> 文字列の配列。コマンド ラインで、1 つ以上のスペース区切り名 該当なし
watchProcessTree watchPidsによって選択されたプロセスの子孫 (子プロセス) も監視するかwatchProcessNames --watch-process-tree true、false false

Note

エラー率はプロキシ設定ではありません。 これを構成するには、GenericRandomErrorPlugin または GraphRandomErrorPlugin の構成セクションで rate プロパティを設定するか、これらのプラグインのいずれかが読み込まれるときに -f, --failure-rate コマンドライン オプションを使用します。