yapi调研

 2021-01-13

目录

1 yapi ER图
2 数据管理
  2.1 修改接口
  2.2 同一接口处理逻辑
3 Mock 优先级说明

  3.1 mock期望
  3.2 自定义 Mock 脚本
  3.3 全局mock
  3.4 普通mock
4 自动化
  4.1 参数化&变量传递
  4.2 响应校验

0 简介

YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。

特性

• 基于 Json5 和 Mockjs 定义接口返回数据的结构和文档，效率提升多倍
• 扁平化权限设计，即保证了大型企业级项目的管理，又保证了易用性
• 类似 postman 的接口调试
• 自动化测试, 支持对 Response 断言
• MockServer 除支持普通的随机 mock 外，还增加了 Mock 期望功能，根据设置的请求过滤规则，返回期望数据
• 支持 postman, har, swagger 数据导入
• 免费开源，内网部署，信息再也不怕泄露了

document

常用 api

• assert(value)
  判断 value 是否为 truth, 例如 assert(1) 通过， assert(0) 不通过，只要 value 不是 null, 0, false 等值验证通过
• assert.equal(actual, expected)
  判断 actual 是否等于 expected，例如 assert(1, 1)通过
• assert.notEqual(actual, expected)
  判断 actual 是否不等于 expected
• assert.deepEqual(actual, expected)
  假设： actual = {a:1} 是一个对象，即便 expected = {a:1}，如果使用 assert.equal 可能也是不相等的，因为在 js 引用的只是对象的一个指针，需要使用 assert.deepEqual 比较两个对象是否相等
• assert.notDeepEaual(actual, expected)
  深度比较两个对象是否不相等

2.status
http 状态码

3.params
http request params, 合并了 query 和 body

4.body
返回 response body

5.header
返回 response header

6.records
记录的 http 请求信息，假设需要获取 key 为 555 的接口参数或者响应数据，可通过 records[555].params 或 records[555].body 获取