Dela via

Konfigurera Dev Proxy

Dev Proxy är mycket konfigurerbar. Den använder plugin-program för att implementera funktionalitet. Du kan kombinera vilka som helst av standard-plugin-program och och bygga dina egna. Genom att använda plugin-program och anpassade konfigurationer kan du skräddarsy Dev Proxy efter dina specifika behov. Dev Proxy innehåller en standardkonfigurationsfil med namnet devproxyrc.json. Filen finns i Dev Proxys installationsmapp.

Tips

Vi rekommenderar att du skapar anpassade konfigurationsfiler. Genom att använda anpassade konfigurationsfiler kan du enkelt växla mellan olika konfigurationer och inkludera dem i källkontrollsystemet tillsammans med projektets kod. Om du lagrar konfigurationen med projektet blir det också enklare att dela den med ditt team.

Om du namnger konfigurationsfilen devproxyrc.json eller devproxyrc.jsoncläser Dev Proxy in den automatiskt från den aktuella katalogen när du startar den. För andra namn anger du filsökvägen i argumentet --config-file när du startar Dev Proxy, till exempel devproxy --config-file ./my-devproxy-config.json.

Konfigurationsfilstruktur

Följande kodfragment visar standardkonfigurationsfilen för Dev Proxy:

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "RetryAfterPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll"
    },
    {
      "name": "GenericRandomErrorPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "genericRandomErrorPlugin"
    }
  ],
  "urlsToWatch": [
    "https://jsonplaceholder.typicode.com/*"
  ],
  "genericRandomErrorPlugin": {
    "errorsFile": "devproxy-errors.json"
  },
  "rate": 50,
  "logLevel": "information",
  "newVersionNotification": "stable",
  "showSkipMessages": true,
  "showTimestamps": true
}

Konfigurationsfilen består av tre avsnitt:

  • Schema, definierat i egenskapen $schema. Se till att konfigurationsfilen är giltig genom att använda samma schemaversion som den Dev Proxy-version som du använder.
  • Listan över plugin-program som Dev Proxy använder, som definierats i matrisen plugins.
  • Allmänna konfigurationsinställningar.

Viktig

Dev Proxy tillämpar plugin-program i den ordning de anges i konfigurationsfilen. Tänk på ordningen för att få önskat beteende.

Vissa plugin-program kan konfigureras och exponera sina egna inställningar. Varje plugin-program har ett eget konfigurationsavsnitt i konfigurationsfilen, som refereras av egenskapen configSection i plugin-definitionen. Mer information om konfigurationsalternativen finns i referensdokumentationen för varje plugin-program.

Tips

Värdet för egenskapen configSection kan vara valfri sträng. Genom att använda olika namn kan du inkludera flera instanser av samma plugin-program, var och en med en annan konfiguration. Du kan behöva referera till samma plugin-program flera gånger, till exempel när du hånar flera API:er med olika felsvar och beteenden.

Dev Proxy Toolkit

Dev Proxy Toolkit är ett Visual Studio Code-tillägg som avsevärt förenklar konfigurationen av Dev Proxy. Här är några av de funktioner som ingår:

  • kodfragment för vanliga konfigurationsscenarier
  • utökad linting och IntelliSense för Dev Proxy-konfigurationsfiler
  • anpassade redigeringsåtgärder och kommandon för att enkelt starta och stoppa Dev Proxy
  • meddelanden om nya versioner av Dev Proxy

Tips

Om du använder Visual Studio Code rekommenderar vi starkt att du installera Tillägget Dev Proxy Toolkit.

Nästa steg

Om du vill lära dig mer om att använda Dev Proxy kan du överväga följande självstudier:

I annat fall kan du ta en titt på våra guider för hur man gör för att lära dig hur du använder Dev Proxy för specifika scenarier.