Referência e instalação do comando da ferramenta OpenAPI do .NET

Microsoft.dotnet-openapi é uma Ferramenta Global do .NET Core para gerenciamento de referências OpenAPI em um projeto.

Instalação

Para instalar Microsoft.dotnet-openapi, execute o seguinte comando:

dotnet tool install -g Microsoft.dotnet-openapi

Observação

Por padrão, a arquitetura dos binários do .NET a serem instalados representa a arquitetura do SO sendo executado no momento. Para especificar uma arquitetura de SO diferente, consulte instalação da ferramenta dotnet, opção --arch. Para obter mais informações, confira o problema dotnet/AspNetCore.Docs #29262 do GitHub.

Adicionar

Adicionar uma referência OpenAPI usando qualquer um dos comandos nesta página adiciona um elemento <OpenApiReference /> semelhante ao seguinte para o arquivo .csproj:

<OpenApiReference Include="openapi.json" />

A referência anterior é necessária para que o aplicativo chame o código do cliente gerado.

Adicionar Arquivo

Opções

Opção curta	Opção longa	Descrição	Exemplo
-p	--updateProject	O projeto no qual operar.	dotnet openapi add file --updateProject .\Ref.csproj .\OpenAPI.json
-c	--code-generator	O gerador de código a ser aplicado à referência. As opções são NSwagCSharp e NSwagTypeScript. Se --code-generator não for especificado, o padrão de ferramentas será NSwagCSharp.	dotnet openapi add file .\OpenApi.json --code-generator
-H	--help	Mostra informações da Ajuda	dotnet openapi add file --help

Argumentos

Argument	Descrição	Exemplo
source-file	A origem da qual criar uma referência. Deve ser um arquivo OpenAPI.	dotnet openapi add file .\OpenAPI.json

Adicionar URL

Opções

Opção curta	Opção longa	Descrição	Exemplo
-p	--updateProject	O projeto no qual operar.	dotnet openapi add url --updateProject .\Ref.csprojhttps://contoso.com/openapi.json
-o	--output-file	Onde colocar a cópia local do arquivo OpenAPI.	dotnet openapi add url https://contoso.com/openapi.json--output-file myclient.json
-c	--code-generator	O gerador de código a ser aplicado à referência. As opções são NSwagCSharp e NSwagTypeScript.	dotnet openapi add url https://contoso.com/openapi.json --code-generator
-H	--help	Mostra informações da Ajuda	dotnet openapi add url --help

Argumentos

Argument	Descrição	Exemplo
source-URL	A origem da qual criar uma referência. Deve ser uma URL.	dotnet openapi add url https://contoso.com/openapi.json

Remover

Remove a referência OpenAPI que corresponde ao nome de arquivo especificado do arquivo .csproj. Quando a referência do OpenAPI for removida, os clientes não serão gerados. Os arquivos .json e .yaml locais são excluídos.

Opções

Opção curta	Opção longa	Descrição	Exemplo
-p	--updateProject	O projeto no qual operar.	dotnet openapi remove --updateProject .\Ref.csproj .\OpenAPI.json
-H	--help	Mostra informações da Ajuda	dotnet openapi remove --help

Argumentos

Argument	Descrição	Exemplo
source-file	A origem à qual remover a referência.	dotnet openapi remove .\OpenAPI.json

Atualizar

Atualiza a versão local de um arquivo que foi baixado usando o conteúdo mais recente da URL de download.

Opções

Opção curta	Opção longa	Descrição	Exemplo
-p	--updateProject	O projeto no qual operar.	dotnet openapi refresh --updateProject .\Ref.csprojhttps://contoso.com/openapi.json
-H	--help	Mostra informações da Ajuda	dotnet openapi refresh --help

Argumentos

Argument	Descrição	Exemplo
source-URL	A URL da qual atualizar a referência.	dotnet openapi refresh https://contoso.com/openapi.json