Partager via

OpenApiSpecGeneratorPlugin

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

Capture d’écran de deux fenêtres d’invite de commandes. L’une affiche les demandes d’API d’enregistrement du proxy de développement. L’autre montre la spécification OpenAPI générée.

Définition de l’instance de plug-in

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

Exemple de configuration

{
  "openApiSpecGeneratorPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/openapispecgeneratorplugin.schema.json",
    "includeOptionsRequests": false,
    "ignoreResponseTypes": false,
    "specVersion": "v3_0",
    "specFormat": "Json",
    "includeParameters": [
      "api-version"
    ]
  }
}

Propriétés de configuration

Property Description Default
includeOptionsRequests Détermine s’il faut inclure des OPTIONS demandes dans la spécification OpenAPI générée false
ignoreResponseTypes Détermine s’il faut ignorer les types de réponse dans la spécification OpenAPI générée. false
specVersion Détermine la version à utiliser pour la spécification OpenAPI générée. Peut être défini sur v2_0 ou v3_0 v3_0
specFormat Détermine le format à utiliser pour la spécification OpenAPI générée. Peut être défini sur Json ou Yaml Json
includeParameters Détermine la liste des paramètres de chaîne de requête à inclure dans la spécification OpenAPI générée, ainsi que leurs valeurs par défaut. []

Options de ligne de commande

None

Remarks

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.

Étape suivante

Générer une spécification OpenAPI

  • Last updated on