Compartir a través de

Configurar Dev Proxy

El proxy de desarrollo es muy configurable. Usa complementos para implementar la funcionalidad. Puede combinar cualquiera de los complementos estándar y crear su propio. Mediante el uso de complementos y configuraciones personalizadas, puede adaptar Dev Proxy a sus necesidades específicas. El proxy de desarrollo incluye un archivo de configuración predeterminado, denominado devproxyrc.json. El archivo se encuentra en la carpeta de instalación del proxy de desarrollo.

Sugerencia

Se recomienda crear archivos de configuración personalizados. Mediante el uso de archivos de configuración personalizados, puede cambiar fácilmente entre distintas configuraciones y puede incluirlos en el sistema de control de código fuente junto con el código del proyecto. Almacenar la configuración con el proyecto también facilita su uso compartido con el equipo.

Si asigna un nombre al archivo de configuración devproxyrc.json o devproxyrc.jsonc, Dev Proxy lo carga automáticamente desde el directorio actual al iniciarlo. Para otros nombres, especifique la ruta de acceso del archivo en el argumento --config-file al iniciar el proxy de desarrollo, por ejemplo, devproxy --config-file ./my-devproxy-config.json.

Estructura del archivo de configuración

El siguiente fragmento de código muestra el archivo de configuración predeterminado del proxy de desarrollo:

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.29.2/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
}

El archivo de configuración consta de tres secciones:

  • Esquema, definido en la propiedad $schema. Para asegurarse de que el archivo de configuración es válido, asegúrese de usar la misma versión de esquema que la versión del proxy de desarrollo que usa.
  • La lista de complementos que usa Dev Proxy, definida en la matriz plugins.
  • Opciones generales de configuración.

Importante

Dev Proxy aplica complementos en el orden en que aparecen en el archivo de configuración. Tenga en cuenta el orden de obtener el comportamiento deseado.

Algunos complementos son configurables y exponen su propia configuración. Cada complemento tiene su propia sección de configuración en el archivo de configuración, a la que hace referencia la propiedad configSection en la definición del complemento. Consulte la documentación de referencia de cada complemento para obtener más información sobre sus opciones de configuración.

Sugerencia

El valor de la propiedad configSection puede ser cualquier cadena. Mediante el uso de nombres diferentes, puede incluir varias instancias del mismo complemento, cada una con una configuración diferente. Es posible que tenga que hacer referencia al mismo complemento varias veces, por ejemplo, al simular varias API con diferentes respuestas y comportamientos de error.

Kit de herramientas de proxy de desarrollo

Dev Proxy Toolkit es una extensión de Visual Studio Code que simplifica significativamente la configuración de Dev Proxy. Estas son algunas de las características que incluye:

  • fragmentos de código para escenarios de configuración comunes
  • linting extendido e IntelliSense para archivos de configuración del proxy de desarrollo
  • acciones y comandos del editor personalizados para iniciar y detener el proxy de desarrollo convenientemente
  • notificaciones sobre las nuevas versiones del proxy de desarrollo

Sugerencia

Si usa Visual Studio Code, le recomendamos encarecidamente que instale la extensión Dev Proxy Toolkit.

Paso siguiente

Si quiere seguir aprendiendo sobre el uso de Dev Proxy, tenga en cuenta los siguientes tutoriales:

De lo contrario, consulte nuestras guías para aprender a usar el proxy de desarrollo para escenarios específicos.