Informazioni di riferimento e installazione dello strumento OpenAPI .NET

Microsoft.dotnet-openapi è uno strumento globale .NET Core per la gestione dei riferimenti OpenAPI all'interno di un progetto.

Installazione

Per installare Microsoft.dotnet-openapi, eseguire il comando seguente:

dotnet tool install -g Microsoft.dotnet-openapi

Nota

Per impostazione predefinita, l'architettura dei file binari .NET da installare rappresenta l'architettura del sistema operativo attualmente in esecuzione. Per specificare un'architettura del sistema operativo diversa, vedere l'opzione dotnet tool install, --arch. Per altre informazioni, vedere Problema di GitHub dotnet/AspNetCore.Docs #29262.

Aggiungere

L'aggiunta di un riferimento OpenAPI usando uno dei comandi in questa pagina aggiunge un <OpenApiReference /> elemento simile al seguente al .csproj file:

<OpenApiReference Include="openapi.json" />

Il riferimento precedente è necessario affinché l'app chiami il codice client generato.

Aggiungi file

Opzioni

Opzione breve	Opzione Lunga	Descrizione	Esempio
-p	--updateProject	Progetto su cui operare.	dotnet openapi add file --updateProject .\Ref.csproj .\OpenAPI.json
-c	--code-generator	Generatore di codice da applicare al riferimento. Le opzioni sono NSwagCSharp e NSwagTypeScript. Se --code-generator non viene specificato l'impostazione predefinita degli strumenti è NSwagCSharp.	dotnet openapi add file .\OpenApi.json --code-generator
-h	--help	Mostra le informazioni della Guida	dotnet openapi add file --help

Argomenti

Argomento	Descrizione	Esempio
source-file	Origine da cui creare un riferimento. Deve essere un file OpenAPI.	dotnet openapi add file .\OpenAPI.json

Aggiungere URL

Opzioni

Opzione breve	Opzione Lunga	Descrizione	Esempio
-p	--updateProject	Progetto su cui operare.	dotnet openapi add url --updateProject .\Ref.csprojhttps://contoso.com/openapi.json
-o	--output-file	Posizione in cui inserire la copia locale del file OpenAPI.	dotnet openapi add url https://contoso.com/openapi.json--output-file myclient.json
-c	--code-generator	Generatore di codice da applicare al riferimento. Le opzioni sono NSwagCSharp e NSwagTypeScript.	dotnet openapi add url https://contoso.com/openapi.json --code-generator
-h	--help	Mostra le informazioni della Guida	dotnet openapi add url --help

Argomenti

Argomento	Descrizione	Esempio
source-URL	Origine da cui creare un riferimento. Deve essere un URL.	dotnet openapi add URL https://contoso.com/openapi.json

Remove

Rimuove il riferimento OpenAPI corrispondente al nome file specificato dal .csproj file. Quando il riferimento OpenAPI viene rimosso, i client non verranno generati. I file e .yaml locali .json vengono eliminati.

Opzioni

Opzione breve	Opzione Lunga	Descrizione	Esempio
-p	--updateProject	Progetto su cui operare.	dotnet openapi remove --updateProject .\Ref.csproj .\OpenAPI.json
-h	--help	Mostra le informazioni della Guida	dotnet openapi remove --help

Argomenti

Argomento	Descrizione	Esempio
source-file	Origine a cui rimuovere il riferimento.	dotnet openapi remove .\OpenAPI.json

Aggiorna

Aggiorna la versione locale di un file scaricato usando il contenuto più recente dall'URL di download.

Opzioni

Opzione breve	Opzione Lunga	Descrizione	Esempio
-p	--updateProject	Progetto su cui operare.	dotnet openapi refresh --updateProject .\Ref.csprojhttps://contoso.com/openapi.json
-h	--help	Mostra le informazioni della Guida	dotnet openapi refresh --help

Argomenti

Argomento	Descrizione	Esempio
source-URL	URL da cui aggiornare il riferimento.	dotnet openapi refresh https://contoso.com/openapi.json