Sdílet prostřednictvím

Konfigurace dev proxy serveru

  • Článek

Dev Proxy je vysoce konfigurovatelný. K implementaci funkcí používá moduly plug-in . Můžete kombinovat kterýkoli ze standardních plug-inů , a , abyste vytvořili vlastní. Pomocí pluginů a vlastních konfigurací můžete Dev Proxy přizpůsobit vašim konkrétním potřebám. Dev Proxy obsahuje výchozí konfigurační soubor s názvem devproxyrc.json. Soubor se nachází v instalační složce dev Proxy.

Spropitné

Doporučujeme vytvořit vlastní konfigurační soubory. Pomocí vlastních konfiguračních souborů můžete snadno přepínat mezi různými konfiguracemi a zahrnout je do systému správy zdrojového kódu spolu s kódem projektu. Uložení konfigurace s projektem také usnadňuje sdílení s týmem.

Pokud konfigurační soubor pojmenujete devproxyrc.json nebo devproxyrc.jsonc, Dev Proxy ho při spuštění automaticky načte z aktuálního adresáře. U jiných názvů zadejte cestu k souboru v argumentu --config-file při spuštění dev Proxy, například devproxy --config-file ./my-devproxy-config.json.

Struktura konfiguračních souborů

Následující fragment kódu ukazuje výchozí konfigurační soubor dev proxy serveru:

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

Konfigurační soubor se skládá ze tří částí:

  • Schéma definované ve vlastnosti $schema Abyste měli jistotu, že je konfigurační soubor platný, nezapomeňte použít stejnou verzi schématu jako verzi dev proxy, kterou používáte.
  • Seznam modulů plug-in, které dev Proxy používá, definovaných v poli plugins.
  • Obecná nastavení konfigurace .

Důležitý

Dev Proxy používá moduly plug-in v pořadí, v jakém jsou uvedené v konfiguračním souboru. Mějte na paměti pořadí, abyste získali požadované chování.

Některé moduly plug-in jsou konfigurovatelné a zveřejňují vlastní nastavení. Každý modul plug-in má v konfiguračním souboru vlastní konfigurační oddíl, na který odkazuje vlastnost configSection v definici modulu plug-in. Další informace o možnostech konfigurace najdete v referenční dokumentaci ke každému modulu plug-in.

Spropitné

Hodnota vlastnosti configSection může být libovolný řetězec. Pomocí různých názvů můžete zahrnout více instancí stejného modulu plug-in, z nichž každá má jinou konfiguraci. Možná budete muset několikrát odkazovat na tentýž plugin, například při simulování více rozhraní API s různými druhy chybových odpovědí a chování.

Dev Proxy Toolkit

dev Proxy Toolkit je rozšíření editoru Visual Studio Code, které výrazně zjednodušuje konfiguraci dev proxy serveru. Tady jsou některé z funkcí, které zahrnuje:

  • Fragmenty kódu pro běžné scénáře konfigurace
  • rozšířené lintování a IntelliSense pro konfigurační soubory Dev Proxy
  • vlastní akce a příkazy editoru pro pohodlné spuštění a zastavení dev proxy serveru
  • oznámení o nových verzích dev proxy serveru

Spropitné

Pokud používáte Visual Studio Code, důrazně doporučujeme nainstalovat rozšíření Dev Proxy Toolkit.

Další krok

Pokud se chcete dozvědět více o používání dev proxy serveru, zvažte následující kurzy:

V opačném případě se podívejte na naše návody, jak používat Dev Proxy pro konkrétní scénáře.