Yapi简单操作流程

Yapi简单操作流程

yapi官方教程: https://yapi.ymfe.org/documents/index.html

一,Yapi生成接口

添加项目

image.png

在项目内添加接口

image.png

接口编辑

image.png

注意点 , mock地址和实际请求地址的区别是分开的 , 见下图

image.png

数据管理内导出swaggerjson数据 比如: swaggerApi.json

二 , 将swaggerApi.json生成java api

方式一: http://editor.swagger.io 使用swagger editor , 直接导入文件 , 生成java文件 , 生成的java文件不太符合我们的规范 , 如下:

image.png

方式二: 使用工具swagger-codegen-cli-2.2.1.jar

1.操作生成Java命令:java -jar swagger-codegen-cli-2.2.1.jar generate -c config.json -i swaggerApi.json -l java -o ./front-mgt

备注:

• config.json是要设置的工程数据

• swaggerApi.json是yapi工具生成的数据

• front-mgt是要生成的Java代码目录

2.查看可以生成的客户端选项

java -jar swagger-codegen-cli-2.4.4.jar config-help -l java

生成的Java代码如下:

image.png

三. 上传swagger数据到Yapi

这个比较简单 , 只需要选定项目后直接拉进去即可

image.png