YApi小结

YApi

优点

颜值高；安装简便；集成WIKI、接口编写、接口自动化测试于一体，更新非常及时；支持权限管理；支持swagger等其他API管理工具的格式数据导入；支持LDAP、SSO、CAS等登录方式；支持集群。

缺点

（1）接口返回值只能设置一个模板
有时候我们希望正确返回设置一个模板、错误返回设置一个模板，这是swagger可以做到的，而YAPI无法做到
（2）接口模板必须复制粘贴
不像swagger解耦合一样，一处配置处处运行，例如配置“分页模板”，然后每个分页只需要引用一下就好了，修改起来只需要修改一次。而YAPI目前只有复制粘贴。
已经有人提issue了：

image.png

3）测试功能太鸡肋
只能做冒烟测试，给数据、返回期望数据。无法编写测试逻辑（如果返回XX则跳到XX），无法返回多个值（如果200则XX，如果404则XX），也就无法编写单元测试了。
简单总结会议：yapi接口管理平台，在开发偏敏捷的情况下，对接口的规范性，前后端联调便捷性，冒烟测试、线上回归，起到了积极作用，但对于测试来说，测试功能比较鸡肋。

总结

该平台的帮助：

    1，mockserver方案：解决前期模拟测试数据，便于调试；
    2，服务端接口开发：规范后台api文档，丰富了开发自测方案，间接提高开发质量；
    3，前后端联调：减少联调沟通成本；
    4，测试方面：更好的进行接口测试，接口冒烟测试，以及线上验收测试；

目前来看存在的问题有如下几个方面：

   1，文档管理方面：接口历史文档查看和管理，无法操作；
   2，接口关联性方面：接口返回数据的获取和下一个接口使用，不易用；
   3，变量管理+前置脚本调试方面：前置脚本sign或其他参数获取，做为公共变量或私有变量传递，不易用；
   4，版本管理：目前tag更多的是标签作用；
   5，自动化方面：异常用例管理和编写，局限性过大，不易进行；
   6，协议局限性：websocket等类似协议接口无法测试；

YApi使用

官方教程

添加项目

1. 创建入口

   
   
   

   image.png

2. 填写项目信息

   
   
   

   image.png
   
   

   3.创建后效果

   
   
   

   image.png

添加分类

image.png

添加接口

1. 添加接口入口

   
   
   

   image.png

2. 添加接口

   
   
   

   image.png

3. 添加成功

   
   
   

   image.png

4. 编辑

   
   
   

   image.png
   
   

   5.请求参数及返回参数
   请求参数：

   
   
   

   image.png
   
   返回参数：（1：手动输入；2：导入json）
   
   

   image.png
   
   

   导入json后效果：

   
   
   

   image.png
   
   可对导入后的数据进行详细填充
   
   

   image.png
   
   6.保存
   7.预览
   
   

   image.png

MOCK

POST请求

mock地址

image.png

postman请求

image.png

GET请求

mock地址

image.png

postman请求

image.png