Mock 接口模拟 API接口管理工具 - YAPI

在java的服务架构在不断进步的今天,前后端分离已经成为大势所趋,但在如此架构下,前后端端同学接口对接也成为延缓开发速度的一大因素

先说一下敏捷开发

1. 产品文档

2. 需求评审

3. 接口梳理

4. 接口定义

5. 前后端同时开发

6. 前后端连调

7. 测试

8. 部署

9. 上线

10. 验证

在这一过程中接口文档随之而生,文件文档word .xls.  生成文档swagger   成为首选 一旦需求改变,接口就会随之改变,文件类型的接口文档可以在接口完成前给出,但与最终的接口肯定会有所出入.swagger是在代码开发的过程中才会出现的;

 

这两种方式都无法做到文档的实时跟新,也无法提供mock接口供前端同学调用

 

各种mock软件随之而生

 

YAPI

1. 安装

   采用docker 安装

2. 配置文件(与docker-compose.yml放在同一目录)

3. 启动

   docker-compose  up -d 

4. 访问

   http://IP:40001 账号:[email protected] 密码:ymfe.org 

5. 操作

6. 1. 新建分组

      

   2. 添加组成员

      

   3. 新建项目

      

   4. 添加分类

      

   5. 添加接口

      

   6. 编辑接口基本信息

      

   7. 编辑接口参数信息

      

   8. Mock地址预览中获取

      

   9. 通过swaggerAPI同步接口

      

   10. 导入与导出

       

   11. 最终效果

       

   12. 环境设置

       

   13. 运行环境与接口可进行简单的接口测试

       

7. 前期接口文档完成后就可以做接口录入

8. 前端同学调用mock接口获取模拟数据

9. 后端同学开发完成后可以通过swagger进行api数据导入

10. 通过设置swagger同步来定时同步接口,做到实时接口更新

11. 好处

12. 1. 在没有接口的时候可以实现前后端接口定义,数据结构一致

    2. 接口实时更新

    3. 简单接口测试

    4. 自动化测试(暂时没有研究)