Générer un fichier HTTP

Le proxy de développement vous permet de générer un fichier HTTP à partir de requêtes et réponses d’API interceptées. L’utilisation de fichiers HTTP est particulièrement utile pour les développeurs qui souhaitent simuler le comportement de l’API ou partager des interactions d’API reproductibles. Le fichier HTTP inclut tous les détails de demande et de réponse pertinents, avec des informations sensibles remplacées par des variables pour la sécurité et la réutilisation.

Pour générer un fichier HTTP à l’aide du proxy de développement :

1. Dans le fichier de configuration, activez le HttpFileGeneratorPlugin.

   {
     "plugins": [
       {
         "name": "HttpFileGeneratorPlugin",
         "enabled": true,
         "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
         "configSection": "httpFileGeneratorPlugin"
       }
     ]
     // [...] shortened for brevity
   }
   

2. Si vous le souhaitez, configurez le plug-in :

   {
     "httpFileGeneratorPlugin": {
       "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/httpfilegeneratorplugin.schema.json",
       "includeOptionsRequests": false
     }
     // [...] shortened for brevity
   }
   

   • includeOptionsRequests: détermine s’il faut inclure des OPTIONS requêtes dans le fichier HTTP généré. La valeur par défaut est false.

3. Dans le fichier de configuration, dans la liste des URL à surveiller, ajoutez l’URL de l’API pour laquelle vous souhaitez générer un fichier HTTP :

   {
     "urlsToWatch": [
       "https://api.example.com/*"
     ]
     // [...] shortened for brevity
   }
   

4. Démarrez le proxy de développement :

   devproxy
   

5. Démarrez l’enregistrement des demandes en appuyant sur r.

6. Effectuez les demandes d’API que vous souhaitez inclure dans le fichier HTTP.

7. Arrêtez l’enregistrement en appuyant sur s.

8. Le proxy de développement génère un fichier HTTP et l’enregistre dans le répertoire actif. Le fichier inclut toutes les demandes et réponses capturées, avec des données sensibles telles que des jetons de porteur et des clés API remplacées par des variables. Par exemple:

   @jsonplaceholder_typicode_com_api_key = api-key
   ###
   # @name getPosts
   GET https://jsonplaceholder.typicode.com/posts?api-key={{jsonplaceholder_typicode_com_api_key}}
   Host: jsonplaceholder.typicode.com
   User-Agent: curl/8.6.0
   Accept: */*
   Via: 1.1 dev-proxy/0.29.0
   

   Le plug-in crée automatiquement des variables pour chaque combinaison de nom d’hôte et de paramètre sensible, les réutilisant dans les requêtes le cas échéant.

Étapes suivantes

En savoir plus sur HttpFileGeneratorPlugin.