PluginDeDécouverteD'URL

Crée une liste d’URL interceptées par le proxy de développement. Utilisez ce plug-in pour savoir quelles URL votre application appelle et comment configurer le proxy de développement pour simuler des comportements pour eux.

Pourboire

Pour enregistrer le résumé dans un fichier, utilisez un plug-in reporter dans votre configuration.

Capture d’écran d’une fenêtre d’invite de commandes fractionnée. Sur le côté gauche, la sortie du proxy de développement affichant les requêtes interceptées. Sur le côté droit, le rapport généré avec des URL interceptées.

Exemple de configuration

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "UrlDiscoveryPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll"
    }
  ]
}

Propriétés de configuration

Aucun

Output

UrlDiscoveryPlugin crée son rapport lorsque vous arrêtez l’enregistrement. Le rapport contient les URL uniques des requêtes interceptées par le proxy de développement, triées par ordre alphabétique. Chaque URL est l’URL de requête complète, y compris sa chaîne de requête.

Pour enregistrer le rapport au format JSON, ajoutez jsonReporter après UrlDiscoveryPlugin dans votre configuration. JsonReporter écrit le rapport dans un fichier nommé UrlDiscoveryPlugin_JsonReporter.jsonc dans le répertoire de travail actif. Si le fichier existe déjà, le proxy de développement ajoute un horodatage au nom du fichier, par exemple UrlDiscoveryPlugin_JsonReporter_20261105104151.jsonc.

Le fichier est un fichier JSON avec des commentaires (JSONC) que vous pouvez utiliser comme point de départ pour la urlsToWatch propriété dans votre configuration du proxy de développement. Le fichier contient des commentaires qui expliquent comment utiliser des caractères génériques et exclure des URL, suivis d’un urlsToWatch tableau avec les URL interceptées :

{
  // Wildcards
  // 
  // You can use wildcards to catch multiple URLs with the same pattern.
  // For example, you can use the following URL pattern to catch all API requests to
  // JSON Placeholder API:
  // 
  // https://jsonplaceholder.typicode.com/*
  // 
  // Excluding URLs
  // 
  // You can exclude URLs with ! to prevent them from being intercepted.
  // For example, you can exclude the URL https://jsonplaceholder.typicode.com/authors
  // by using the following URL pattern:
  // 
  // !https://jsonplaceholder.typicode.com/authors
  // https://jsonplaceholder.typicode.com/*
  "urlsToWatch": [
    "https://jsonplaceholder.typicode.com/posts",
    "https://jsonplaceholder.typicode.com/users",
    "https://jsonplaceholder.typicode.com/users/1"
  ]
}
Propriété Description
urlsToWatch Tableau de chaînes. URL uniques des requêtes interceptées par le proxy de développement lors de l’enregistrement, triées par ordre alphabétique. Les URL ne contiennent pas de caractères génériques

Important

Étant donné que le fichier contient des commentaires, des analyseurs JSON standard, comme JSON.parse en JavaScript ou jq, ne parviennent pas à l’analyser. Pour lire le fichier dans un script, utilisez un analyseur qui prend en charge les commentaires, comme JSON5 ou le jsonc-parser package npm, ou supprimez les lignes de commentaire avant d’analyser le fichier.

Voir aussi

Étape suivante