.NET OpenAPI 工具命令参考和安装

安装

若要安装 Microsoft.dotnet-openapi，请运行以下命令：

dotnet tool install -g Microsoft.dotnet-openapi

注意

默认情况下，要安装的 .NET 二进制文件的体系结构表示当前运行的 OS 体系结构。若要指定不同的 OS 体系结构，请参阅 dotnet tool install, --arch option。有关详细信息，请参阅 GitHub 问题 dotnet/AspNetCore.Docs #29262。

使用本页上的任意命令添加 OpenAPI 引用会将类似于以下内容的 <OpenApiReference /> 元素添加到 .csproj 文件：

<OpenApiReference Include="openapi.json" />

必须有上述引用，应用才可以调用生成的客户端代码。

短选项	长选项	描述	示例
-p	--updateProject	要操作的项目。	dotnet openapi add file --updateProject .\Ref.csproj .\OpenAPI.json
-c	--code-generator	应用于引用的代码生成器。选项包括 `NSwagCSharp` 和 `NSwagTypeScript`。如果未指定 `--code-generator`，则工具将默认为 `NSwagCSharp`。	dotnet openapi add file .\OpenApi.json --code-generator
-H	--help	显示帮助信息	dotnet openapi add file --help

Argument	说明	示例
source-file	要创建的引用的源。必须为 OpenAPI 文件。	dotnet openapi add file .\OpenAPI.json

短选项	长选项	描述	示例
-p	--updateProject	要操作的项目。	dotnet openapi add url --updateProject .\Ref.csproj`https://contoso.com/openapi.json`
-o	--output-file	用于放置 OpenAPI 文件本地副本的位置。	dotnet openapi add url `https://contoso.com/openapi.json` --output-file myclient.json
-c	--code-generator	应用于引用的代码生成器。选项包括 `NSwagCSharp` 和 `NSwagTypeScript`。	dotnet openapi add url `https://contoso.com/openapi.json` --code-generator
-H	--help	显示帮助信息	dotnet openapi add url --help

Argument	说明	示例
source-URL	要创建的引用的源。必须是 URL。	dotnet openapi add url `https://contoso.com/openapi.json`

删除与 .csproj 文件中给定文件名匹配的 OpenAPI 引用。.csproj 删除 OpenAPI 引用后，将不会生成客户端。本地 .json 和 .yaml 文件将被删除。

短选项	长选项	描述	示例
-p	--updateProject	要操作的项目。	dotnet openapi remove --updateProject .\Ref.csproj .\OpenAPI.json
-H	--help	显示帮助信息	dotnet openapi remove --help

Argument	说明	示例
source-file	要删除的引用的源。	dotnet openapi remove .\OpenAPI.json

使用下载 URL 中的最新内容刷新已下载的文件本地版本。

短选项	长选项	描述	示例
-p	--updateProject	要操作的项目。	dotnet openapi refresh --updateProject .\Ref.csproj`https://contoso.com/openapi.json`
-H	--help	显示帮助信息	dotnet openapi refresh --help

Argument	说明	示例
source-URL	用于刷新引用的 URL。	dotnet openapi refresh `https://contoso.com/openapi.json`