介紹#
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 編輯器,可以生成伺服器和客戶端的代碼