1、第一步:打开YApi网址,点击数据管理,数据导出选择swaggerjson,点击导出,将导出的json文件复制到项目根目录。
2、第二步:全局安装swagger-api-codegen,控制台输入swagger --help
3、第三步:初始化配置文件, 控制台输入swagger init
4、第四步:生成api层代码,控制台输入swagger g api
至此我们生成api的操作已经完成,接下来我们来看下,自动生成api有哪些好处
1、代码自动调用提示及自动导包:
2、接口传参提示:
3、返回值提示:
4、入参不对或返回值取值不对时在编译时就可以抛出错误,避免在对接接口的时候出现各种参数比配不上的问题。
5、api层避免手写接口出错,cli生成大大节省了编写api层所耗费的时间。
6、如果项目是js的,可以使用tsc将文件编译成js 和 .d.ts 一样可以享受类型推导带来的便捷
其他使用方式:
vscode在应用商店中搜索 Carve Swagger Api Codegen 并安装
安装完成后在项目目录中右键,点击生成api层
另外还有配置提示功能