共用方式為

設定開發 Proxy

  • 發行項

Dev Proxy 有高度的可配置性。 它會使用 外掛程式 來實作功能。 您可以結合任何 標準外掛程式，並 建置您自己的。 藉由使用外掛程式和自訂設定，您可以依據特定需求量身打造 Dev Proxy。 開發人員 Proxy 包含名為 devproxyrc.json的預設組態檔。 檔案位於 Dev Proxy 的安裝資料夾中。

提示

建議您建立自定義組態檔。 藉由使用自定義組態檔，您可以輕鬆地在不同的組態之間切換，並將這些組態包含在原始檔控制系統中，以及項目的程序代碼。 將您的組態與專案一同儲存，也可讓您更輕鬆地與團隊共用。

如果您將組態檔命名為 devproxyrc.json 或 devproxyrc.jsonc，當您啟動組態檔時，Dev Proxy 會自動從目前目錄載入它。 若為其他名稱，請在啟動 Dev Proxy 時，在 --config-file 自變數中指定檔案路徑，例如 devproxy --config-file ./my-devproxy-config.json。

配置檔結構

下列代碼段顯示預設的 Dev Proxy 組態檔：

{
  "$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
}

組態檔包含三個區段：

  • 架構，定義於 $schema 屬性中。 若要確保您的組態檔有效，請務必使用與您所使用的開發 Proxy 版本相同的架構版本。
  • 開發 Proxy 使用的外掛程式清單，定義於 plugins 陣列中。
  • 一般 組態設定。

重要

Dev Proxy 會依照外掛程式列在組態檔中的順序套用。 請留意取得所需行為的順序。

某些外掛程式可設定並公開自己的設定。 每個外掛程式在組態檔中都有自己的組態區段，由外掛程式定義中的 configSection 屬性參考。 請參閱每個外掛程式的參考檔，以深入瞭解其組態選項。

提示

configSection 屬性的值可以是任何字串。 藉由使用不同的名稱，您可以包含相同外掛程式的多個實例，每個實例都有不同的組態。 例如，模擬具有不同錯誤響應和行為的多個 API 時，您可能需要多次參考相同的外掛程式。

開發者 Proxy 工具組

Dev Proxy Toolkit 是可大幅簡化開發 Proxy 設定的 Visual Studio Code 擴充功能。 以下是包含的一些功能：

  • 常見配置情境的程式碼片段
  • 適用於開發 Proxy 組態檔的擴充 Linting 和 IntelliSense
  • 自訂的編輯器動作和命令，方便啟動和停止開發代理
  • 關於新版本 Dev Proxy 的通知

提示

如果您使用 Visual Studio Code，強烈建議您 安裝 Dev Proxy Toolkit 擴充功能。

下一步

如果您想要繼續使用 Dev Proxy，請考慮下列教學課程：

否則，請查看我們的 使用指南，瞭解如何在特定情境中使用 Dev Proxy。