OpenApiSpecGeneratorPlugin

Génère des spécifications OpenAPI au format JSON à partir des requêtes et réponses interceptées.

Définition de l’instance de plug-in

{
  "name": "OpenApiSpecGeneratorPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
  "configSection": "openApiSpecGeneratorPlugin"
}

Exemple de configuration

{
  "openApiSpecGeneratorPlugin": {
    "includeOptionsRequests": false
  }
}

Propriétés de configuration

Propriété	Description	Default
includeOptionsRequests	Détermine s’il faut inclure des OPTIONS demandes dans la spécification OpenAPI générée	false

Options de ligne de commande

Aucune

Notes

Pour créer de meilleures spécifications OpenAPI, envisagez d’utiliser un modèle de langage local avec le proxy de développement. À l’aide d’un modèle de langage local, les OpenApiSpecGeneratorPlugin ID d’opération et les descriptions plus clairs génèrent un meilleur point de départ pour votre spécification OpenAPI. Pour utiliser un modèle de langue locale avec le OpenApiSpecGeneratorPluginmodèle de langue, activez le modèle de langue dans le fichier de configuration. Pour plus d’informations, consultez Utiliser un modèle de langue locale.