什么是YAPI
简单的一句话就是:YAPI是一个API文档管理平台
YAPI的核心作用就是管理API文档,将项目的API同步给项目参与者(开发,测试,产品);
怎么使用YAPI
后台开发人员
在yapi上建立项目分组/在项目分组下建立项目
idea中添加easyYapi插件
安装插件
进入 preferences -> Plugins , 搜索 “EasyYapi” , 安装该插件<br>
维护yapi的server
维护tokens<br>
配置插件
Preferences(Settings) > Other Settings > EasyApi<br>
维护代码注释
生成文档到YAPI上
将本地注释同步到yapi上
YAPI文档标准
维护YAPI文档使用的标准
使用JavaDoc标准进行注解维护
前端开发人员
查看yapi文档
查看API变动情况
参考地址
EasyYapi插件文档
YAPI的官方文档<br>
YApi v1.3.x 可视化接口管理平台文档教程
使用过程中发生的问题
controller推送的yapi模块名显示<p><br>
controller多个方法共用一个VO,生成yapi文档后,无法确认当前接口的适用参数--由于多个方法使用同一个VO导致VO对象中存在参数冗余
枚举中出现注释,导致yapi生成的文档中,枚举内容不全(丢失第一行)<br>