Référence et installation des commandes de l’outil .NET OpenAPI

Microsoft.dotnet-openapi est un outil global .NET Core permettant de gérer les références OpenAPI au sein d’un projet.

Installation

Pour installer Microsoft.dotnet-openapi, exécutez la commande suivante :

dotnet tool install -g Microsoft.dotnet-openapi

Remarque

Par défaut, l’architecture des fichiers binaires .NET à installer représente l’architecture du système d’exploitation en cours d’exécution. Pour spécifier une architecture de système d’exploitation différente, consultez dotnet tool install, --arch option. Pour plus d'informations, consultez le problème GitHub dotnet/AspNetCore.Docs n° 29262.

Ajouter

L’ajout d’une référence OpenAPI à l’aide de l’une des commandes de cette page ajoute un élément <OpenApiReference /> similaire au fichier .csproj suivant :

<OpenApiReference Include="openapi.json" />

La référence précédente est requise pour que l’application appelle le code client généré.

Ajouter un fichier

Options

Option courte	Option longue	Description	Exemple :
-p	--updateProject	Projet sur lequel opérer.	dotnet openapi ajoute le fichier --updateProject .\Ref.csproj .\OpenAPI.json
-c	--code-generator	Générateur de code à appliquer à la référence. Les options sont NSwagCSharp et NSwagTypeScript. Si --code-generator n’est pas spécifié, les outils par défaut sont NSwagCSharp.	dotnet openapi ajoute le fichier .\OpenApi.json --code-generator
-h	--help	Afficher les informations d’aide	dotnet openapi ajouter le fichier --help

Arguments

Argument	Description	Exemple :
source-file	Source à partir de laquelle créer une référence. Doit être un fichier OpenAPI.	dotnet openapi ajouter le fichier .\OpenAPI.json

Ajouter une URL

Options

Option courte	Option longue	Description	Exemple :
-p	--updateProject	Projet sur lequel opérer.	dotnet openapi ajoute l’URL --updateProject .\Ref.csprojhttps://contoso.com/openapi.json
-o	--output-file	Où placer la copie locale du fichier OpenAPI.	dotnet openapi ajoute l’URL https://contoso.com/openapi.json--output-file myclient.json
-c	--code-generator	Générateur de code à appliquer à la référence. Les options sont NSwagCSharp et NSwagTypeScript.	dotnet openapi ajoute l’URL https://contoso.com/openapi.json --code-generator
-h	--help	Afficher les informations d’aide	dotnet openapi ajoute l’URL --help

Arguments

Argument	Description	Exemple :
source-URL	Source à partir de laquelle créer une référence. Il doit s'agir d'une URL.	dotnet openapi ajoute l’URL https://contoso.com/openapi.json

Remove

Supprime du fichier .csproj la référence OpenAPI correspondant au nom de fichier donné. Lorsque la référence OpenAPI est supprimée, les clients ne sont pas générés. Les fichiers locaux .json et .yaml sont supprimés.

Options

Option courte	Option longue	Description	Exemple :
-p	--updateProject	Projet sur lequel opérer.	dotnet openapi supprime --updateProject .\Ref.csproj .\OpenAPI.json
-h	--help	Afficher les informations d’aide	dotnet openapi supprime --help

Arguments

Argument	Description	Exemple :
source-file	Source à laquelle supprimer la référence.	dotnet openapi supprime .\OpenAPI.json

Actualiser

Actualise la version locale d’un fichier téléchargé à l’aide du contenu le plus récent à partir de l’URL de téléchargement.

Options

Option courte	Option longue	Description	Exemple :
-p	--updateProject	Projet sur lequel opérer.	dotnet openapi actualise --updateProject .\Ref.csprojhttps://contoso.com/openapi.json
-h	--help	Afficher les informations d’aide	dotnet openapi actualise --help

Arguments

Argument	Description	Exemple :
source-URL	URL à partir de laquelle actualiser la référence.	dotnet openapi actualise https://contoso.com/openapi.json