梦想博客

OpenApi文档自动生成sdk

calendar 2025/05/27
refresh-cw 2025/05/27
210字,1分钟
分类: webapi
tag webapi; sdk;

前言 🔗

写好的weibai文档一直需要手动去对,比较繁琐,而且当修改时也需要前端对修改,突然发现个工具可以通过webapi的openapi.json进行自动化sdk的生成处理

实操 🔗

首先安装nodejs,然后在cli中输入

1npm install @openapitools/openapi-generator-cli -g

安装完成后,可以生成特定语言的sdk,以typescript距离,生成的命令如下

1openapi-generator-cli generate -i "C:\Users\Administrator.DESKTOP-1A2DGNK\Desktop\sdk\1.json" -g typescript-axios -o "C:\Users\Administrator.DESKTOP-1A2DGNK\Desktop\sdk\demo"

生成后的代码近乎开箱即用,并可以进行特定化设置,更多语言请参阅这里




某些文档都看不全的傻逼前端有福了