Générer un fichier TypeSpec

Le proxy de développement vous permet de générer un fichier TypeSpec à partir des requêtes et réponses d’API interceptées. À l’aide du proxy de développement, vous pouvez rapidement créer un fichier TypeSpec pour une API existante et tirer parti des outils qui prennent en charge TypeSpec.

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

1. Dans le fichier de configuration, activez le TypeSpecGeneratorPlugin plug-in :

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

2. Si vous le souhaitez, configurez le plug-in dans le fichier de configuration :

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

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 TypeSpec :

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

   Conseil / Astuce

   Pour créer de meilleurs fichiers TypeSpec, envisagez d’utiliser un modèle de langage local avec le proxy de développement. À l’aide d’un modèle de langage local, TypeSpecGeneratorPlugin génère des ID d’opération et des descriptions plus clairs, ce qui vous donne un meilleur point de départ pour votre fichier TypeSpec. Pour plus d’informations, consultez Utiliser un modèle de langue locale.

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

   devproxy
   

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

6. Effectuer les demandes que vous souhaitez inclure dans le fichier TypeSpec

7. Arrêter l’enregistrement des demandes en appuyant sur s

8. Le proxy de développement génère un fichier TypeSpec et l’enregistre dans un fichier dans le répertoire actif. Le proxy de développement nomme le fichier après le nom d’hôte de l’API suivi de la date et de l’heure actuelles, par exemple : api.example.com-20231219091700.tsp.

Étapes suivantes

En savoir plus sur TypeSpecGeneratorPlugin.

TypeSpecGeneratorPlugin