YAPI使用教程
部署
详细部署流程可以查看 YAPI 官方文档>内网部署
这里我们开发者学习, 建议找个docker 镜像, 一键安装, 这里我们使用的是 fjc0k/docker-YApi
通过 download 解压压缩包, docker-compose 部署:
-
修改 docker-compose.yml 中的邮箱YAPI_ADMIN_ACCOUNT 和 YAPI_ADMIN_PASSWORD.
-
启动服务:
在docker-compose.yml所在目录下执行
docker-compose up -d -
打开 YAPI服务地址 登录
基本操作
进入主页后, 有操作引导, 创建项目等操作很简单,不做过多介绍. 介绍一些平时使用频率比较高的操作.
详细操作请移步官方使用文档
数据导入
支持: swagger , postman , json , HAR 多种格式
项目中选中 数据管理 > 数据导入 选择你需要的格式
在线测试
可以自定义多种用例.
选中项目中
接口 > 测试集合> 添加测试集合
选中添加的
断言
测试结果
总体来说, 还是有一定局限性的. 比方说 我没有找到 设置前置动作和后置动作的入口.
也许有通过开放 API接入自动化平台 或者 自定义插件实现吧. 期待
Mock Server
支持入参, 响应结果 mock 期望
测试 case 入参 mock
响应结果mock
数据导出
导出格式:html,markdown,json
安装插件
YAPI 伸缩性很强, 开放的插件开发窗口. 点击查看开源 YApi 插件列表
在 docker-Yapi 中我们只要在 docker-compose.yaml 中配置即可
比如 我们这里要装 自动化测试插件
以fjc0k/docker-YApi为例, 我们做一下配置
在 docker-compose.yaml 这样配置
去掉前缀 yapi-plugin-
YAPI_PLUGINS=[{"name":"auto-test"}]
之后重启 yapi-web 容器
docker-compose restart yapi-web
开放 API
通过 YAPI 的开放 API 可以做很多事情, 比如对接私有平台, 比如开发插件等等.
总结
- UI 舒服, 用户操作体验极佳
- 可视化接口管理, 支持附件上传、图片预览等场景富文本编辑器功能
- 支持内网部署
- 在线测试, 自动化测试
- 多版本/ 团队协作功能
- Mock Server
- 多种格式的数据导入导出
- 支持自定义插件
- 提供开发 API
思考
这里会发现我们在编写完 Yapi 接口之后. 在代码中仍然要写一遍注释.虽然也只写了两边. 但是也还是觉得麻烦.
这里我们引入下文. IDEA 插件 EasyYapi
写在最后
还是老三样. 欢迎 点赞, 转发, 评论 ~