YAPI使用学习
2022-02-11 17:17:44 1 举报AI智能生成
为什么使用YAPI，如何使用YAPI，使用YAPI有什么作用
作者其他创作
大纲/内容
什么是YAPI
简单的一句话就是：YAPI是一个API文档管理平台
YAPI的核心作用就是管理API文档，将项目的API同步给项目参与者（开发，测试，产品）；
为什么使用YAPI
解决过去API文档维护和使用中的各种不便问题
后台开发方面的不便
创建接口文档时，需要进行对于接口文档的单独维护，操作上产生工作冗余
接口变更后，修改文档不方便
文档变更后，对于接口文档变动没有好的版本控制，不知道变更前后的差异
前端使用方面的不便
接口变动后由于更新不及时，或者忘记更新导致操作错误
开发时需要等后台人员写好实现，才能进行前端实现的开发
后端成员变更接口后，没有感知
测试成员方面的不便
接口变动无法感知
测试用例需要单独维护
无法快速进行接口测试
怎么使用YAPI
运营人员
搭建yapi
后台开发人员
在yapi上建立项目分组/在项目分组下建立项目
idea中添加easyYapi插件
安装插件
进入 preferences -> Plugins , 搜索 “EasyYapi” , 安装该插件
维护yapi的server
维护tokens
配置插件
Preferences(Settings) > Other Settings > EasyApi
维护代码注释
生成文档到YAPI上
将本地注释同步到yapi上
YAPI文档标准
必须要维护的信息
controller
类名词
类描述
api
参数
api描述
api名称
返回值描述
model
类名称
字段信息
维护YAPI文档使用的标准
使用JavaDoc标准进行注解维护
前端开发人员
查看yapi文档
使用mock
数据mock
高级mock
查看API变动情况
测试人员
自动化测试
参考地址
EasyYapi插件文档
YAPI的官方文档
YApi v1.3.x 可视化接口管理平台文档教程
使用过程中发生的问题
controller推送的yapi模块名显示<p>
controller多个方法共用一个VO，生成yapi文档后，无法确认当前接口的适用参数--由于多个方法使用同一个VO导致VO对象中存在参数冗余
枚举中出现注释，导致yapi生成的文档中，枚举内容不全（丢失第一行）
0 条评论
下一页
