Referenční informace k příkazům a instalaci nástroje .NET OpenAPI

Microsoft.dotnet-openapi je globální nástroj .NET pro správu odkazů OpenAPI v rámci projektu.

Installation

Instalaci provedete Microsoft.dotnet-openapispuštěním následujícího příkazu:

dotnet tool install -g Microsoft.dotnet-openapi

Note

Ve výchozím nastavení architektura binárních souborů .NET, které se mají nainstalovat, představuje aktuálně spuštěnou architekturu operačního systému. Pokud chcete zadat jinou architekturu operačního systému, přečtěte si téma instalace nástroje dotnet, možnost --arch. Další informace najdete v tématu o problému GitHubu dotnet/AspNetCore.Docs #29262.

Add

Přidání odkazu OpenAPI pomocí některého z příkazů na této stránce přidá <OpenApiReference /> prvek podobný následujícímu .csproj souboru:

<OpenApiReference Include="openapi.json" />

Předchozí odkaz se vyžaduje, aby aplikace volala vygenerovaný klientský kód.

Přidat soubor

Možnosti

Krátká možnost	Dlouhá možnost	Description	Example
-p	--updateProject	Projekt, na kterém se má pracovat.	dotnet openapi add soubor --updateProject .\Ref.csproj .\OpenAPI.json
-c	--code-generator	Generátor kódu, který se použije na odkaz. Možnosti jsou NSwagCSharp a NSwagTypeScript. Pokud --code-generator není zadán nástroj výchozí NSwagCSharphodnota .	dotnet openapi add file .\OpenApi.json --s generátorem kódu
-h	--help	Zobrazit informace nápovědy	dotnet openapi add file --help

Arguments

Argument	Description	Example
source-file	Zdroj pro vytvoření odkazu z. Musí to být soubor OpenAPI.	dotnet openapi add file .\OpenAPI.json

Přidat adresu URL

Možnosti

Krátká možnost	Dlouhá možnost	Description	Example
-p	--updateProject	Projekt, na kterém se má pracovat.	dotnet openapi add url --updateProject .\Ref.csprojhttps://contoso.com/openapi.json
-o	--output-file	Kam umístit místní kopii souboru OpenAPI	dotnet openapi add url https://contoso.com/openapi.json--output-file myclient.json
-c	--code-generator	Generátor kódu, který se použije na odkaz. Možnosti jsou NSwagCSharp a NSwagTypeScript.	dotnet openapi add url https://contoso.com/openapi.json --code-generator
-h	--help	Zobrazit informace nápovědy	dotnet openapi add url --help

Arguments

Argument	Description	Example
source-URL	Zdroj pro vytvoření odkazu z. Musí to být adresa URL.	dotnet openapi add url https://contoso.com/openapi.json

Remove

Odebere odkaz OpenAPI odpovídající danému .csproj názvu souboru ze souboru. Po odebrání odkazu OpenAPI se klienti negenerují. Místní .json soubory a .yaml soubory se odstraní.

Možnosti

Krátká možnost	Dlouhá možnost	Description	Example
-p	--updateProject	Projekt, na kterém se má pracovat.	dotnet openapi remove --updateProject .\Ref.csproj .\OpenAPI.json
-h	--help	Zobrazit informace nápovědy	dotnet openapi remove --nápověda

Arguments

Argument	Description	Example
source-file	Zdroj, na který chcete odebrat odkaz.	dotnet openapi remove .\OpenAPI.json

Refresh

Aktualizuje místní verzi souboru, který byl stažen pomocí nejnovějšího obsahu z adresy URL pro stažení.

Možnosti

Krátká možnost	Dlouhá možnost	Description	Example
-p	--updateProject	Projekt, na kterém se má pracovat.	dotnet openapi refresh --updateProject .\Ref.csprojhttps://contoso.com/openapi.json
-h	--help	Zobrazit informace nápovědy	dotnet openapi refresh --help

Arguments

Argument	Description	Example
source-URL	Adresa URL, ze které se má odkaz aktualizovat.	dotnet openapi refresh https://contoso.com/openapi.json