关注小程序 找一找教程网-随时随地学编程

OpenAPI 工具

使用 OpenAPI 工具开发 ASP.NET Core 应用

作者:Ryan Brandenburg

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

安装

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

dotnet tool install -g Microsoft.dotnet-openapi

添加

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

<OpenApiReference Include="openapi.json" />

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

添加文件

选项

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

自变量

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

添加 URL

选项

短选项 长选项 描述 示例
-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 应用于引用的代码生成器。 选项包括 NSwagCSharpNSwagTypeScript dotnet openapi add file .\OpenApi.json --code-generator
-h --help 显示帮助信息 dotnet openapi add url --help

自变量

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

删除

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

选项

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

自变量

参数 描述 示例
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

自变量

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