TypeSpecGeneratorPlugin

Génère des fichiers TypeSpec à partir des requêtes et réponses interceptées.

Définition de l’instance de plug-in

{
  "name": "TypeSpecGeneratorPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
  "configSection": "typeSpecGeneratorPlugin"
}

Exemple de configuration

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

Propriétés de configuration

Propriété	Descriptif	Par défaut
ignoreResponseTypes	Détermine s’il faut générer des types pour les réponses de l’API (false) ou leur attribuer la valeur string (true).	false

Options de ligne de commande

Aucun

Remarques

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 en langue locale, le génère des ID et des descriptions d’opération TypeSpecGeneratorPlugin plus clairs, ce qui vous donne un meilleur point de départ pour votre fichier TypeSpec. Pour utiliser un modèle de langue locale avec la commande TypeSpecGeneratorPlugin, activez le modèle de langue dans le fichier de configuration. Pour plus d’informations, consultez Utiliser un modèle de langue locale.