Kommandoreferens och installation av .NET OpenAPI-verktyget

Microsoft.dotnet-openapi är ett .NET Global Tool för att hantera OpenAPI-referenser i ett projekt.

Installation

Microsoft.dotnet-openapiInstallera genom att köra följande kommando:

dotnet tool install -g Microsoft.dotnet-openapi

Note

Som standard representerar arkitekturen för de .NET-binärfiler som ska installeras den operativsystemarkitektur som körs. Information om hur du anger en annan OPERATIVSYSTEM-arkitektur finns i dotnet tool install, --arch option. Mer information finns i GitHub issue dotnet/AspNetCore.Docs #29262.

Add

Om du lägger till en OpenAPI-referens med något av kommandona på den här sidan läggs ett <OpenApiReference /> element som liknar följande till .csproj filen:

<OpenApiReference Include="openapi.json" />

Föregående referens krävs för att appen ska kunna anropa den genererade klientkoden.

Lägg till fil

Options

Kort alternativ	Långt alternativ	Description	Example
-p	--updateProject	Projektet som ska köras.	dotnet openapi add file --updateProject .\Ref.csproj .\OpenAPI.json
-c	--code-generator	Kodgeneratorn som ska tillämpas på referensen. Alternativen är NSwagCSharp och NSwagTypeScript. Om --code-generator inte anges standardvärdet för verktyget är NSwagCSharp.	dotnet openapi add file .\OpenApi.jspå --code-generator
-h	--help	Visa hjälpinformation	dotnet openapi add file --help

Arguments

Argument	Description	Example
källfil	Källan som du vill skapa en referens från. Måste vara en OpenAPI-fil.	dotnet openapi lägg till fil .\OpenAPI.json

Lägg till URL

Options

Kort alternativ	Långt alternativ	Description	Example
-p	--updateProject	Projektet som ska köras.	dotnet openapi add url --updateProject .\Ref.csprojhttps://contoso.com/openapi.json
-o	--output-file	Var du ska placera den lokala kopian av OpenAPI-filen.	dotnet openapi add url https://contoso.com/openapi.json--output-file myclient.json
-c	--code-generator	Kodgeneratorn som ska tillämpas på referensen. Alternativen är NSwagCSharp och NSwagTypeScript.	dotnet openapi add url https://contoso.com/openapi.json --code-generator
-h	--help	Visa hjälpinformation	dotnet openapi add url --help

Arguments

Argument	Description	Example
source-URL	Källan som du vill skapa en referens från. Måste vara en URL.	dotnet openapi add url https://contoso.com/openapi.json

Remove

Tar bort OpenAPI-referensen som matchar det angivna filnamnet från .csproj filen. När OpenAPI-referensen tas bort genereras inte klienter. Lokala .json filer och .yaml filer tas bort.

Options

Kort alternativ	Långt alternativ	Description	Example
-p	--updateProject	Projektet som ska köras.	dotnet openapi remove --updateProject .\Ref.csproj .\OpenAPI.json
-h	--help	Visa hjälpinformation	dotnet openapi remove --help (Kommandot tar bort en OpenAPI-referens.)

Arguments

Argument	Description	Example
källfil	Källan som du vill ta bort referensen till.	dotnet openapi ta bort .\OpenAPI.json

Refresh

Uppdaterar den lokala versionen av en fil som laddades ned med det senaste innehållet från nedladdnings-URL:en.

Options

Kort alternativ	Långt alternativ	Description	Example
-p	--updateProject	Projektet som ska köras.	dotnet openapi refresh --updateProject .\Ref.csprojhttps://contoso.com/openapi.json
-h	--help	Visa hjälpinformation	dotnet openapi refresh --help

Arguments

Argument	Description	Example
source-URL	Url:en som referensen ska uppdateras från.	dotnet openapi refresh https://contoso.com/openapi.json