介绍#
Kiota 是微软开源的基于 OpenAPI 规范生成 API SDK 的跨平台命令行工具。
它为了提供对 OpenAPI 的全面支持,选择了 Microsoft.OpenAPI.NET 作为底层支持。
支持生成的语言#
它可以为 C#、CLI、Go、Java、PHP、Python、Ruby、Swift 和 TypeScript 等语言生成客户端代码,点击链接可以更加清晰的看到它支持的客户端语言种类:https://github.com/microsoft/kiota#supported-languages
安装#
官方提供了很多种安装方式,我选择用 .NET tool 来安装:
dotnet tool install --global Microsoft.OpenApi.Kiota
使用#
直接执行 kiota
命令就可以看到它支持的参数,也可以看文档。
示例:
kiota generate --openapi https://petstore.swagger.io/v2/swagger.json --output d:\test --language TypeScript
如果后续接口更新了,相应地,SDK 也需要更新。需要注意的是,现在只能通过指定 --output
参数来告诉 kiota 更新哪个目录里面的 SDK,即便在输出目录中执行,也需要指定一个相对路径 "."。
kiota update --output .
也可以点击链接,查看 kiota 为各个语言生成的客户端代码:https://github.com/microsoft/kiota-samples
其它工具#
- NSwag 生成客户端代码的 Windows GUI 工具,经常用
- Swagger Editor Open API 编辑器,可以生成服务器和客户端的代码