Partager via

Configurer le proxy de développement

  • Article

Le proxy de développement est hautement configurable. Il utilise plug-ins pour implémenter des fonctionnalités. Vous pouvez combiner l’un des plug-ins standard et créer votre propre. En utilisant des plug-ins et des configurations personnalisées, vous pouvez adapter le proxy de développement à vos besoins spécifiques. Le proxy de développement inclut un fichier de configuration par défaut, nommé devproxyrc.json. Le fichier se trouve dans le dossier d’installation du proxy de développement.

Conseil

Nous vous recommandons de créer des fichiers de configuration personnalisés. En utilisant des fichiers de configuration personnalisés, vous pouvez facilement basculer entre différentes configurations et les inclure dans votre système de contrôle de code source, ainsi que le code de votre projet. Le stockage de votre configuration avec votre projet facilite également le partage avec votre équipe.

Si vous nommez votre fichier de configuration devproxyrc.json ou devproxyrc.jsonc, le proxy de développement le charge automatiquement à partir du répertoire actif lorsque vous le démarrez. Pour d’autres noms, spécifiez le chemin d’accès du fichier dans l’argument --config-file lors du démarrage du proxy de développement, par exemple devproxy --config-file ./my-devproxy-config.json.

Structure de fichiers de configuration

L’extrait de code suivant montre le fichier de configuration du proxy de développement par défaut :

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

Le fichier de configuration se compose de trois sections :

  • Schéma, défini dans la propriété $schema. Pour vous assurer que votre fichier de configuration est valide, veillez à utiliser la même version de schéma que la version du proxy de développement que vous utilisez.
  • Liste des plug-ins que le proxy de développement utilise, définis dans le tableau plugins.
  • Paramètres de configuration généraux .

Important

Le proxy de développement applique les plug-ins dans l’ordre dans lequel ils sont répertoriés dans le fichier de configuration. Soyez attentif à l'ordre pour obtenir le comportement souhaité.

Certains plug-ins sont configurables et exposent leurs propres paramètres. Chaque plug-in a sa propre section de configuration dans le fichier de configuration, référencée par la propriété configSection dans la définition du plug-in. Consultez la documentation de référence de chaque plug-in pour en savoir plus sur ses options de configuration.

Conseil

La valeur de la propriété configSection peut être n’importe quelle chaîne. En utilisant différents noms, vous pouvez inclure plusieurs instances du même plug-in, chacune avec une configuration différente. Vous devrez peut-être référencer le même plug-in plusieurs fois, par exemple lors de la simulation de plusieurs API avec différentes réponses d’erreur et comportements.

Kit de ressources du proxy de développement

Dev Proxy Toolkit est une extension Visual Studio Code qui simplifie considérablement la configuration du proxy de développement. Voici quelques-unes des fonctionnalités qu’il inclut :

  • Extraits de code pour les scénarios de configuration courants
  • linting étendu et IntelliSense pour les fichiers de configuration du proxy de développement
  • actions et commandes personnalisées de l’éditeur pour démarrer et arrêter facilement le proxy de développement
  • notifications sur les nouvelles versions du proxy de développement

Conseil

Si vous utilisez Visual Studio Code, nous vous recommandons vivement d’installer l’extension Kit de ressources du proxy de développement.

Étape suivante

Si vous souhaitez continuer à en savoir plus sur l’utilisation du proxy de développement, tenez compte des didacticiels suivants :

Sinon, consultez nos guides pratiques pour apprendre à utiliser le proxy de développement pour des scénarios spécifiques.