# yapi mock 服务介绍
# 背景
- 业务开发过程中,前端开发时常发现后端提供的接口文档与实际情况不一致
- 后端编辑和维护接口文档需要耗费不少精力,伴随着接口的迭代,接口文档的维护逐渐跟不上,出现更新不及时的情况
- 接口的正确性和稳定性难以保证
- 传统的本地mock效率低,维护成本高
# yapi mock 服务的优点
- 支持接口swagger导入等导入方式,提高接口的正确性与稳定性,一定程度上减少接口维护成本
- yapi mock服务,可根据接口自定义生成返回数据,便于测试
# yapi 接入的前提条件
- 对应的项目后端开发人员创建并维护了对应的yapi项目
# mock 接入规范
- 推荐采用yapi ,便于统一和维护,yapi文档 (opens new window);
- yapi mock接口规范:
${yapi-origin}/mock/${project-id}/${api-path}
; - 项目中接入yapi时,优先以环境变量来判断是否启用mock服务,以免将mock数据部署到生产环境;
- 若项目中存在接口存放在不同的yapi项目中、不满足全局开启mock的情况,可以在一个文件内维护yapi地址列表和是否开启对应yapi mock 服务的标识,在请求方法中判断对应接口是否请求mock服务。