開発プロキシの構成
開発プロキシは高度に構成可能です。 プラグイン を使用して機能を実装します。 標準のプラグインを任意で組み合わせて、独自のプラグインを構築できます。 プラグインとカスタム構成を使用すると、特定のニーズに合わせて開発プロキシを調整できます。 開発プロキシには、devproxyrc.jsonという名前の既定の構成ファイルが含まれています。 ファイルは、開発プロキシのインストール フォルダーにあります。
ヒント
カスタム構成ファイルを作成することをお勧めします。 カスタム構成ファイルを使用すると、さまざまな構成を簡単に切り替え、プロジェクトのコードと共にソース管理システムに含めることができます。 構成をプロジェクトに格納すると、チームとの共有も容易になります。
構成ファイルに devproxyrc.json または devproxyrc.jsoncという名前を付けると、起動時に、Dev Proxy によって現在のディレクトリから自動的に読み込まれます。 その他の名前については、開発プロキシの起動時に --config-file 引数にファイル パスを指定します (例: devproxy --config-file ./my-devproxy-config.json)。
構成ファイルの構造
次のコード スニペットは、既定の開発プロキシ構成ファイルを示しています。
{
"$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.24.0/rc.schema.json",
"plugins": [
{
"name": "RetryAfterPlugin",
"enabled": true,
"pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll"
},
{
"name": "GenericRandomErrorPlugin",
"enabled": true,
"pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
"configSection": "genericRandomErrorPlugin"
}
],
"urlsToWatch": [
"https://jsonplaceholder.typicode.com/*"
],
"genericRandomErrorPlugin": {
"errorsFile": "devproxy-errors.json"
},
"rate": 50,
"logLevel": "information",
"newVersionNotification": "stable",
"showSkipMessages": true,
"showTimestamps": true
}
構成ファイルは、次の 3 つのセクションで構成されます。
- スキーマ。
$schemaプロパティで定義されます。 構成ファイルが有効であることを確認するには、使用している Dev Proxy バージョンと同じスキーマ バージョンを使用してください。 plugins配列で定義されている、開発プロキシが使用するプラグインの一覧。- 全般構成設定。
重要
開発プロキシは、構成ファイルに記載されている順序でプラグインを適用します。 目的の動作を取得する順序に注意してください。
一部のプラグインは構成可能であり、独自の設定を公開します。 各プラグインには、プラグイン定義の configSection プロパティによって参照される、構成ファイルに独自の構成セクションがあります。 各プラグインの構成オプションの詳細については、各プラグインのリファレンス ドキュメントを参照してください。
ヒント
configSection プロパティの値には任意の文字列を指定できます。 異なる名前を使用することで、同じプラグインの複数のインスタンスを含めることができます。それぞれに異なる構成を持つインスタンスを含めることができます。 エラー応答や動作が異なる複数の API をモックする場合など、同じプラグインを複数回参照する必要がある場合があります。
Dev Proxy Toolkit
Dev Proxy Toolkit は、開発プロキシの構成を大幅に簡略化する Visual Studio Code 拡張機能です。 次に示すのは、その機能の一部です。
- 一般的な構成シナリオのコード スニペット
- 開発プロキシ構成ファイルの拡張リンティングと IntelliSense
- 開発プロキシを簡単に開始および停止するためのカスタム エディターのアクションとコマンド
- 開発プロキシの新しいバージョンに関する通知
ヒント
Visual Studio Code を使用する場合は、Dev Proxy Toolkit 拡張機能 インストールすることを強くお勧めします。
次の手順
開発プロキシの使用について学習し続ける場合は、次のチュートリアルを検討してください。
- 独自のアプリケーション のランダム エラーをシミュレートする
- Microsoft Graph を呼び出す JavaScript クライアント側 Web アプリケーションをテストする
- JavaScript クライアント側の Web アプリケーション をテストする
それ以外の場合は、特定のシナリオで開発プロキシを使用する方法 ガイドの を確認してください。
Dev Proxy