Delen via

Dev-proxy configureren

  • Artikel

Dev Proxy is hoogstwaarschijnlijk configureerbaar. Er worden invoegtoepassingen gebruikt om functionaliteit te implementeren. U kunt een van de standaard plugins combineren en uw eigenbouwen. Door invoegtoepassingen en aangepaste configuraties te gebruiken, kunt u Dev Proxy aanpassen aan uw specifieke behoeften. Dev Proxy bevat een standaardconfiguratiebestand met de naam devproxyrc.json. Het bestand bevindt zich in de installatiemap van Dev Proxy.

Tip

U wordt aangeraden aangepaste configuratiebestanden te maken. Met behulp van aangepaste configuratiebestanden kunt u eenvoudig schakelen tussen verschillende configuraties en deze opnemen in uw broncodebeheersysteem, samen met de code van uw project. Door uw configuratie op te slaan met uw project, kunt u deze eenvoudiger delen met uw team.

Als u uw configuratiebestand devproxyrc.json of devproxyrc.jsoncnoemt, laadt Dev Proxy het automatisch uit de huidige directory wanneer u het start. Geef voor andere namen het bestandspad op in het argument --config-file bij het starten van dev-proxy, bijvoorbeeld devproxy --config-file ./my-devproxy-config.json.

Structuur van configuratiebestand

In het volgende codefragment ziet u het standaardconfiguratiebestand voor de 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
}

Het configuratiebestand bestaat uit drie secties:

  • Schema, gedefinieerd in de eigenschap $schema. Als u ervoor wilt zorgen dat uw configuratiebestand geldig is, moet u dezelfde schemaversie gebruiken als de Dev Proxy-versie die u gebruikt.
  • De lijst met invoegtoepassingen die dev proxy gebruikt, gedefinieerd in de plugins matrix.
  • Algemene configuratie-instellingen.

Belangrijk

Dev Proxy past invoegtoepassingen toe in de volgorde waarin ze worden vermeld in het configuratiebestand. Houd rekening met de volgorde om het gewenste gedrag te krijgen.

Sommige invoegtoepassingen kunnen worden geconfigureerd en hun eigen instellingen beschikbaar maken. Elke invoegtoepassing heeft een eigen configuratiesectie in het configuratiebestand waarnaar wordt verwezen door de eigenschap configSection in de definitie van de invoegtoepassing. Raadpleeg de referentiedocumentatie voor elke invoegtoepassing voor meer informatie over de configuratieopties.

Tip

De waarde van de eigenschap configSection kan elke tekenreeks zijn. Met behulp van verschillende namen kunt u meerdere exemplaren van dezelfde invoegtoepassing opnemen, elk met een andere configuratie. Mogelijk moet u meerdere keren naar dezelfde invoegtoepassing verwijzen, bijvoorbeeld wanneer u meerdere API's met verschillende foutreacties en -gedrag bespot.

Dev Proxy Toolkit

Dev Proxy Toolkit is een Visual Studio Code-extensie die het configureren van Dev Proxy aanzienlijk vereenvoudigt. Hier volgen enkele van de functies die het bevat:

  • codefragmenten voor algemene configuratiescenario's
  • uitgebreide linting en IntelliSense voor Dev Proxy-configuratiebestanden
  • aangepaste editoracties en -opdrachten om dev proxy gemakkelijk te starten en te stoppen
  • meldingen over nieuwe versies van Dev Proxy

Tip

Als u Visual Studio Code gebruikt, raden we u ten zeerste aan om de Dev Proxy Toolkit -extensie te installeren.

Volgende stap

Als u meer wilt weten over het gebruik van Dev Proxy, raadpleegt u de volgende zelfstudies:

Bekijk anders onze instructies voor voor meer informatie over het gebruik van Dev Proxy voor specifieke scenario's.