如何使用YApiDocking

2020-06-06  本文已影响0人  chanyi

YApiDocking是一个使用java代码将项目中的接口一键导出到YApi系统的一个小工具
YApiDocking采用spring 框架完成
YApiDocking的github地址:https://github.com/chanyi/YApiDocking

1、YApiDocking使用

1、安装部署YApi

参照文章:https://www.jianshu.com/p/4f7403422b48

2、创建项目

登录系统,创建项目,获取项目的projectId、token和此次登录状态的cookie


获取重要参数
获取cookie

3、将YApiDocking导入到自己的项目中

copy YApiDocking的坐标,加入到自己项目的pom文件中

4、修改配置

修改YApiDocking项目的配置文件,填入自己的token和cookie


修改配置文件

5、一键执行

运行controller包下的GeneYApiController类的geneYApi方法
或者通过http://127.0.0.1:10011/geneYApi/geneYApi执行

执行
其中的packagePath是自己项目中想要将接口导出到YApi的接口所在的包名。projectId是第二步中自己创建的项目projectId

6、查看效果

效果

7、注意

如果参数名导出是arg0,arg1这种情况。请进行如下设置:
在setting中找到java compiler,然后再红框中填入-parameters,ok即可。
图形如下:


设置
上一篇 下一篇

猜你喜欢

热点阅读