使用 OpenAPI 工具开发 ASP.NET Core 应用Develop ASP.NET Core apps using OpenAPI tools

本文内容

作者：Ryan Brandenburg

Microsoft.dotnet-openapi 是用于管理项目内 OpenAPI 引用的 .NET Core 全局工具。

安装Installation

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

  1. dotnet tool install -g Microsoft.dotnet-openapi

添加Add

使用本页上的任意一个命令添加 OpenAPI 引用，将向 .csproj 文件添加如下所示的 <OpenApiReference /> 元素：

  1. <OpenApiReference Include="openapi.json" />

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

添加文件Add File

选项Options

短选项长选项说明示例
-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

参数Arguments

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

添加 URLAdd URL

选项Options

短选项长选项说明示例
-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 file .\OpenApi.json —code-generator
-H—help显示帮助信息dotnet openapi add url —help

参数Arguments

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

删除Remove

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

选项Options

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

参数Arguments

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

刷新Refresh

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

选项Options

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

参数Arguments

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