Freigeben über

Konfigurieren des Dev-Proxys

  • Artikel

Dev Proxy ist hochgradig konfigurierbar. Es verwendet Plug-Ins, um Funktionen zu implementieren. Sie können jedes der Standard-Plug-Ins kombinieren und eigene erstellen. Mithilfe von Plug-Ins und benutzerdefinierten Konfigurationen können Sie Dev Proxy an Ihre spezifischen Anforderungen anpassen. Dev Proxy enthält eine Standardkonfigurationsdatei namens devproxyrc.json. Die Datei befindet sich im Installationsordner von Dev Proxy.

Tipp

Es wird empfohlen, benutzerdefinierte Konfigurationsdateien zu erstellen. Mithilfe von benutzerdefinierten Konfigurationsdateien können Sie problemlos zwischen verschiedenen Konfigurationen wechseln und diese zusammen mit dem Code Ihres Projekts in Ihr Quellcodeverwaltungssystem einbeziehen. Wenn Sie Ihre Konfiguration mit Ihrem Projekt speichern, können Sie sie auch einfacher für Ihr Team freigeben.

Wenn Sie Ihre Konfigurationsdatei devproxyrc.json oder devproxyrc.jsoncbenennen, lädt Dev Proxy sie automatisch aus dem aktuellen Verzeichnis, wenn Sie sie starten. Geben Sie für andere Namen den Dateipfad im argument --config-file beim Starten von Dev Proxy an, z. B. devproxy --config-file ./my-devproxy-config.json.

Konfigurationsdateistruktur

Der folgende Codeausschnitt zeigt die Standardmäßige Dev Proxy-Konfigurationsdatei:

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

Die Konfigurationsdatei besteht aus drei Abschnitten:

  • Schema, das in der eigenschaft $schema definiert ist. Um sicherzustellen, dass Ihre Konfigurationsdatei gültig ist, verwenden Sie unbedingt dieselbe Schemaversion wie die dev Proxy-Version, die Sie verwenden.
  • Die Liste der Plug-Ins, die Dev Proxy verwendet, ist im plugins-Array definiert.
  • Allgemeine Konfigurationseinstellungen.

Wichtig

Dev Proxy wendet Plug-Ins in der Reihenfolge an, in der sie in der Konfigurationsdatei aufgeführt sind. Achten Sie auf die Reihenfolge, um das gewünschte Verhalten zu erhalten.

Einige Plug-Ins sind konfigurierbar und machen ihre eigenen Einstellungen verfügbar. Jedes Plug-In verfügt über einen eigenen Konfigurationsabschnitt in der Konfigurationsdatei, auf den die configSection-Eigenschaft in der Plug-In-Definition verweist. Weitere Informationen zu den Konfigurationsoptionen finden Sie in der Referenzdokumentation für jedes Plug-In.

Tipp

Der Wert der configSection-Eigenschaft kann eine beliebige Zeichenfolge sein. Mit unterschiedlichen Namen können Sie mehrere Instanzen desselben Plug-Ins mit jeweils einer anderen Konfiguration einschließen. Möglicherweise müssen Sie mehrmals auf dasselbe Plug-In verweisen, z. B. beim Modellieren mehrerer APIs mit unterschiedlichen Fehlerantworten und Verhaltensweisen.

Dev Proxy Toolkit

Dev Proxy Toolkit ist eine Visual Studio Code-Erweiterung, die die Konfiguration von Dev Proxy erheblich vereinfacht. Hier sind einige der Features, die es enthält:

  • Codeausschnitte für allgemeine Konfigurationsszenarien
  • erweiterte Linting- und IntelliSense-Funktionen für Dev-Proxy-Konfigurationsdateien
  • Benutzerdefinierte Editoraktionen und -befehle, um Dev Proxy bequem zu starten und zu beenden
  • Benachrichtigungen über neue Versionen von Dev Proxy

Tipp

Wenn Sie Visual Studio Code verwenden, wird dringend empfohlen, die Dev Proxy Toolkit-Erweiterung zu installieren.

Nächster Schritt

Wenn Sie weiterhin mehr über die Verwendung von Dev Proxy erfahren möchten, sollten Sie die folgenden Lernprogramme in Betracht ziehen:

Sehen Sie sich andernfalls unsere Anleitungen an, um zu erfahren, wie Sie Dev Proxy für bestimmte Szenarien verwenden.