.NET OpenAPI-Tool Befehlsreferenz und Installation

Microsoft.dotnet-openapi ist ein globales .NET Core-Tool zum Verwalten von OpenAPI-Verweisen innerhalb eines Projekts.

Installation

Führen Sie den folgenden Befehl aus, um Microsoft.dotnet-openapi zu installieren:

dotnet tool install -g Microsoft.dotnet-openapi

Hinweis

Standardmäßig stellt die Architektur der zu installierenden .NET-Binärdateien die derzeit ausgeführte Betriebssystemarchitektur dar. Informationen zum Angeben einer anderen Betriebssystemarchitektur finden Sie unter dotnet tool install, --arch option. Weitere Informationen finden Sie unter GitHub Issue dotnet/docs #29262.

Hinzufügen

Wenn Sie eine OpenAPI-Referenz mit einem der Befehle auf dieser Seite hinzufügen, wird ein <OpenApiReference />-Element ähnlich dem folgenden in die Datei .csproj eingefügt:

<OpenApiReference Include="openapi.json" />

Der oben genannte Verweis ist erforderlich, damit die App den generierten Clientcode aufrufen kann.

Datei hinzufügen

Tastatur

Kurze Option	Lange Option	Beschreibung	Beispiel
-p	--updateProject	Das Projekt, das bearbeitet werden soll.	dotnet openapi add file --updateProject .\Ref.csproj .\OpenAPI.json
-c	--code-generator	Der Codegenerator, der auf den Verweis angewendet werden soll. Die Optionen sind NSwagCSharp und NSwagTypeScript. Wenn --code-generator nicht angegeben ist, werden standardmäßig NSwagCSharp-Tools verwendet.	dotnet openapi add file .\OpenApi.json --code-generator
-h	--help	Anzeigen von Hilfeinformationen	dotnet openapi add file --help

Argumente

Argument	Beschreibung	Beispiel
source-file	Die Quelle, aus der ein Verweis erstellt werden soll. Es muss sich um eine OpenAPI-Datei handeln.	dotnet openapi add file .\OpenAPI.json

URL hinzufügen

Tastatur

Kurze Option	Lange Option	Beschreibung	Beispiel
-p	--updateProject	Das Projekt, das bearbeitet werden soll.	dotnet openapi add url --updateProject .\Ref.csproj https://contoso.com/openapi.json
-o	--output-file	Speicherort für die lokale Kopie der OpenAPI-Datei.	dotnet openapi add url https://contoso.com/openapi.json --output-file myclient.json
-c	--code-generator	Der Codegenerator, der auf den Verweis angewendet werden soll. Die Optionen sind NSwagCSharp und NSwagTypeScript.	dotnet openapi add url https://contoso.com/openapi.json --code-generator
-h	--help	Anzeigen von Hilfeinformationen	dotnet openapi add url --help

Argumente

Argument	Beschreibung	Beispiel
source-URL	Die Quelle, aus der ein Verweis erstellt werden soll. Es muss sich um eine URL handeln.	dotnet openapi add url https://contoso.com/openapi.json

Remove

Entfernt die OpenAPI-Referenz, die dem angegebenen Dateinamen entspricht, aus der Datei .csproj. Wenn der OpenAPI-Verweis entfernt wird, werden keine Clients generiert. Die lokalen Dateien .json und .yaml werden gelöscht.

Tastatur

Kurze Option	Lange Option	Beschreibung	Beispiel
-p	--updateProject	Das Projekt, das bearbeitet werden soll.	dotnet openapi remove --updateProject .\Ref.csproj .\OpenAPI.json
-h	--help	Anzeigen von Hilfeinformationen	dotnet openapi remove --help

Argumente

Argument	Beschreibung	Beispiel
source-file	Die Quelle, aus der der Verweis entfernt werden soll.	dotnet openapi remove .\OpenAPI.json

Aktualisieren

Aktualisiert die lokale Version einer Datei, die unter Verwendung der neuesten Download-URL heruntergeladen wurde.

Tastatur

Kurze Option	Lange Option	Beschreibung	Beispiel
-p	--updateProject	Das Projekt, das bearbeitet werden soll.	dotnet openapi refresh --updateProject .\Ref.csproj https://contoso.com/openapi.json
-h	--help	Anzeigen von Hilfeinformationen	dotnet openapi refresh --help

Argumente

Argument	Beschreibung	Beispiel
source-URL	Die URL, aus der der Verweis aktualisiert werden soll.	dotnet openapi refresh https://contoso.com/openapi.json