前端驱动的接口数据检查、文档生成、mock 以及自动化测试-唐霜

我们项目开发时，时常面临这样的问题，在接【访问 www.tangshuang.net 获取更多精彩内容】原创内容，盗版必究。口对接时，前后端脱钩，并行开发时相互限制原创内容，盗版必究。【版权所有，侵权必究】拖慢开发效率。以往，这件事常常是后端主导未经授权，禁止复制转载。原创内容，盗版必究。的，后端同学输出的接口不能满足前端需求，转载请注明出处：www.tangshuang.net【版权所有，侵权必究】这也是为什么 graghql 火起来的原【原创不易，请尊重版权】本文版权归作者所有，未经授权不得转载。因。如何去优化这个场景呢？经过一段时间的本文版权归作者所有，未经授权不得转载。【原创内容，转载请注明出处】探索之后，最终我找到了如下的解决方案，在【未经授权禁止转载】【作者：唐霜】这个方案中，有前端同学来主导这个过程。通【本文受版权保护】原创内容，盗版必究。过这个方案，希望和广大开发者共同思考这一【本文首发于唐霜的博客】【转载请注明来源】问题。

本文版权归作者所有，未经授权不得转载。【作者：唐霜】

数据类型检查、文档、mock以及测试

【访问 www.tangshuang.n原创内容，盗版必究。未经授权，禁止复制转载。et 获取更多精彩内容】本文版权归作者所有，未经授权不得转载。

类型模块

该模块用于撰写项目中需要做类型检查的类型【未经授权禁止转载】【未经授权禁止转载】文件，一般，一个 *.type.js 中【原创不易，请尊重版权】著作权归作者所有，禁止商业用途转载。包含了多个类型容器，这些容器都对应了自己本文作者：唐霜，转载请注明出处。【本文受版权保护】的数据结构，以及每个节点上的值的类型。在本文版权归作者所有，未经授权不得转载。著作权归作者所有，禁止商业用途转载。抛开其他所有相关环节之外，类型模块在前端著作权归作者所有，禁止商业用途转载。【未经授权禁止转载】代码中的作用就是做数据结构、节点类型检查【本文受版权保护】本文版权归作者所有，未经授权不得转载。的。

转载请注明出处：www.tangshua【转载请注明来源】【原创内容，转载请注明出处】ng.net本文作者：唐霜，转载请注明出处。【作者：唐霜】

import { BookType } from './book.type.js'

class Book extends Component {
  request() {
    this.props.request().then(data => {
      Ty.expect(data).to.match(BookType)
      // ...
    })
  }
}

BookService.get = (id) => CommentService.request('GET', '/book/' + id).then(data => {
  Ty.trace(data).by(BookType).catch(error => console.error(error)) // 异步校验，避免带来性能损耗
  return data
})

类型模块规定了一个数据的结构，在上面的这【关注微信公众号：wwwtangshuangnet】本文作者：唐霜，转载请注明出处。个例子中，也就对应了一个接口的返回结果。

import { Dict, Positive } from 'tyshemo'

export const BookType = new Dict({
  name: String,
  price: Positive,
})

既然有了接口的数据结构，及其类型，那么我【原创不易，请尊重版权】未经授权，禁止复制转载。们是否可以生成出该接口的文档？

【访问 www.tangshuang.n【本文首发于唐霜的博客】【访问 www.tangshuang.net 获取更多精彩内容】et 获取更多精彩内容】本文版权归作者所有，未经授权不得转载。【访问 www.tangshuang.n【未经授权禁止转载】本文版权归作者所有，未经授权不得转载。et 获取更多精彩内容】原创内容，盗版必究。

文档服务

当我们有了类型容器之后，我们也可以将这些【关注微信公众号：wwwtangshuangnet】【本文受版权保护】类型容器的内容，格式化为描述语言性质的文【未经授权禁止转载】原创内容，盗版必究。档。例如上面的 BookType 可以格著作权归作者所有，禁止商业用途转载。著作权归作者所有，禁止商业用途转载。式化为：

本文版权归作者所有，未经授权不得转载。【关注微信公众号：wwwtangshua著作权归作者所有，禁止商业用途转载。【作者：唐霜】ngnet】本文作者：唐霜，转载请注明出处。【作者：唐霜】

{
  name: string,
  price: positive,
}

这是一段纯文本，但是它非常清晰的描述了一著作权归作者所有，禁止商业用途转载。【转载请注明来源】个对象的所有。那么，我们就需要有一个服务本文版权归作者所有，未经授权不得转载。【本文受版权保护】来整合接口文档所需要的东西。

一个接口的文档描述中，需要包含如下信息：

接口别名

未经授权，禁止复制转载。

本文作者：唐霜，转载请注明出处。

接口描述

【原创不易，请尊重版权】

【未经授权禁止转载】

接口的请求类型

【关注微信公众号：wwwtangshua【转载请注明来源】未经授权，禁止复制转载。ngnet】

【本文受版权保护】

转载请注明出处：www.tangshua未经授权，禁止复制转载。【本文受版权保护】ng.net

接口的 URL

【原创内容，转载请注明出处】

本文作者：唐霜，转载请注明出处。

接口的请求参数及其类型

未经授权，禁止复制转载。

【作者：唐霜】

接口的返回结构及其类型

原创内容，盗版必究。

【原创内容，转载请注明出处】

【作者：唐霜】

接口的错误及错误码表

【转载请注明来源】

【未经授权禁止转载】

【原创内容，转载请注明出处】

那么，我们在配置文档服务的时候，针对单个转载请注明出处：www.tangshuang.net转载请注明出处：www.tangshuang.net接口，我们就要把上面这些信息全部配置进去转载请注明出处：www.tangshuang.net本文作者：唐霜，转载请注明出处。。

【本文受版权保护】本文作者：唐霜，转载请注明出处。

{
  name: '接口1',
  description: '该接口用于获取用户信息',
  method: 'get',
  path: '/users/:id',
  request: RequestType, // 一个类型容器，用于校验请求参数是否符合类型和结构
  response: ResponseType, // 一个类型容器，用于校验响应体的类型和结构
  errorMapping: { // 一个 mapping 表，用于列出所有错误 code 值码
    10001: '数据库连接错误',
  }, 
}

其中 method 和 path 需要按【原创内容，转载请注明出处】未经授权，禁止复制转载。照 expressjs 的路由格式来处理【未经授权禁止转载】【未经授权禁止转载】，因为我们在后面需要用到它们。另外，我们转载请注明出处：www.tangshuang.net【转载请注明来源】想要起一个文档服务，我们可能还需要对字段【本文首发于唐霜的博客】本文版权归作者所有，未经授权不得转载。进行备注，这时，我找到一种方法，就是在【原创内容，转载请注明出处】原创内容，盗版必究。ResponseType 上挂载一个 _【原创内容，转载请注明出处】【本文首发于唐霜的博客】_comments 属性来添加备注信息：

【本文受版权保护】未经授权，禁止复制转载。著作权归作者所有，禁止商业用途转载。

ResponseType.__comments = {
  'name': '书名',
  'price': '价格',
}

但是，这种方式其实是不好的，因为这样就把【本文受版权保护】原创内容，盗版必究。备注和源码分开了，但是，实际上，我们希望本文作者：唐霜，转载请注明出处。本文版权归作者所有，未经授权不得转载。在源码中通过注释进行备注。目前我还没有找【作者：唐霜】【本文首发于唐霜的博客】到运行时的方法去解决这个问题，想到的方案【关注微信公众号：wwwtangshuangnet】【原创不易，请尊重版权】是编译时通过工具去提取备注，但还未实现。

【本文受版权保护】本文作者：唐霜，转载请注明出处。

【原创不易，请尊重版权】【原创内容，转载请注明出处】

Mock 服务

但文档并不能解决运行时的问题。前端开发到【未经授权禁止转载】【关注微信公众号：wwwtangshuangnet】一定阶段的时候，一定要与接口去联调，有了【版权所有】唐霜 www.tangshuang.net【本文受版权保护】接口之后，才能进行下一步的操作。这种情况转载请注明出处：www.tangshuang.net【原创内容，转载请注明出处】下，我们需要一个 mock 服务，在后端【原创不易，请尊重版权】【作者：唐霜】没有开发完时，可以前端先 mock，完成【未经授权禁止转载】【访问 www.tangshuang.net 获取更多精彩内容】开发的大部分事情。

既然我们有了文档，我们发现，文档服务的配转载请注明出处：www.tangshuang.net【版权所有】唐霜 www.tangshuang.net置中会规定 method、path 两项【版权所有】唐霜 www.tangshuang.net【本文受版权保护】，我们就可以利用它们，结合 expres【转载请注明来源】【关注微信公众号：wwwtangshuangnet】s 框架，起一个本地服务器。另外就返回的原创内容，盗版必究。著作权归作者所有，禁止商业用途转载。数据，我们有了对应的类型容器，可不可以在【原创不易，请尊重版权】著作权归作者所有，禁止商业用途转载。类型容器的基础上生成 mock 数据？当转载请注明出处：www.tangshuang.net原创内容，盗版必究。然可以。

【本文受版权保护】【未经授权禁止转载】

例如，我们可以将 number 生成一个本文作者：唐霜，转载请注明出处。【访问 www.tangshuang.net 获取更多精彩内容】随机数，可以将 string 生成一个随【原创不易，请尊重版权】【作者：唐霜】机字符串，并且通过随机因子，实现 boo本文作者：唐霜，转载请注明出处。本文作者：唐霜，转载请注明出处。lean、ifexist 等不同情况下值原创内容，盗版必究。【原创不易，请尊重版权】可能不同的效果。

【原创内容，转载请注明出处】【本文首发于唐霜的博客】

通过一系列的处理之后，我们只需要利用配置【转载请注明来源】【原创内容，转载请注明出处】信息，就可以对所有的接口进行 mock，【转载请注明来源】本文版权归作者所有，未经授权不得转载。当前端向 mock 服务接口发请求的时候【转载请注明来源】【本文首发于唐霜的博客】，返回 mock 数据。前端最好自己起一【本文首发于唐霜的博客】著作权归作者所有，禁止商业用途转载。个 node 服务，通过代理的形式，拦截本文版权归作者所有，未经授权不得转载。本文版权归作者所有，未经授权不得转载。原本往正式的后台接口发请求的路径，将请求【原创不易，请尊重版权】本文作者：唐霜，转载请注明出处。转发到 mock 服务上去。

【转载请注明来源】本文版权归作者所有，未经授权不得转载。【本文首发于唐霜的博客】

测试服务

现在，我们将视角转移到后端的同学身上，我原创内容，盗版必究。未经授权，禁止复制转载。们切换身份，现在你是后台开发的同学。在对【版权所有】唐霜 www.tangshuang.net【作者：唐霜】照文档开发过程中，你可能并不知道自己写的未经授权，禁止复制转载。【原创不易，请尊重版权】接口是否正常工作，但是前端的同学不可能跟【访问 www.tangshuang.net 获取更多精彩内容】未经授权，禁止复制转载。着你去进行测试。你可能会选择使用 pos【本文首发于唐霜的博客】原创内容，盗版必究。tman 来发送假请求，这样做是可以的。转载请注明出处：www.tangshuang.net转载请注明出处：www.tangshuang.net但是，你需要每次都去假造请求数据，这一点本文作者：唐霜，转载请注明出处。【转载请注明来源】比较麻烦。

在前文中，我们配置了请求时发送的数据类型【本文首发于唐霜的博客】【关注微信公众号：wwwtangshuangnet】容器，那么，有没有办法通过这个容器，生成【作者：唐霜】【版权所有，侵权必究】一个随机的请求数据呢？当然是可以的，和本文作者：唐霜，转载请注明出处。【作者：唐霜】mock 服务生成随机数据一样，我们以未经授权，禁止复制转载。【版权所有】唐霜 www.tangshuang.netrequest 配置为基础，生成一个请求本文版权归作者所有，未经授权不得转载。【转载请注明来源】参数，并通过 method、path 等转载请注明出处：www.tangshuang.net著作权归作者所有，禁止商业用途转载。配置，完成模拟请求。通过这些模拟请求，就【本文受版权保护】【访问 www.tangshuang.net 获取更多精彩内容】可以判断自己写的接口是否正常工作。

此外，我们再为测试服务加上自动化测试的功【访问 www.tangshuang.net 获取更多精彩内容】【关注微信公众号：wwwtangshuangnet】能。

【访问 www.tangshuang.n转载请注明出处：www.tangshuang.net转载请注明出处：www.tangshuang.netet 获取更多精彩内容】【关注微信公众号：wwwtangshua【原创不易，请尊重版权】未经授权，禁止复制转载。ngnet】著作权归作者所有，禁止商业用途转载。

由于在大部分情况下，后台登陆都需要浏览器本文版权归作者所有，未经授权不得转载。本文版权归作者所有，未经授权不得转载。窗口记录登陆状态，因此，我将测试服务设计【版权所有，侵权必究】【原创内容，转载请注明出处】为前端浏览器能力，而非后台的测试平台。通【本文首发于唐霜的博客】转载请注明出处：www.tangshuang.net过一个虚拟的定时任务，反复的构造假数据向未经授权，禁止复制转载。本文版权归作者所有，未经授权不得转载。后台接口发送请求，以此来统计请求成功和失【转载请注明来源】未经授权，禁止复制转载。败的数量。在测试阶段，这也会有帮助。

【本文受版权保护】本文作者：唐霜，转载请注明出处。著作权归作者所有，禁止商业用途转载。转载请注明出处：www.tangshua原创内容，盗版必究。【未经授权禁止转载】ng.net

统一维护类型

前端对这些类型具有强依赖，类型文件会被直原创内容，盗版必究。本文版权归作者所有，未经授权不得转载。接使用到前端代码中，用来作为运行时的类型本文作者：唐霜，转载请注明出处。【访问 www.tangshuang.net 获取更多精彩内容】检查。（但是在产品阶段这不是必须的，可以【本文受版权保护】本文版权归作者所有，未经授权不得转载。通过工具，将类型检查代码从原始代码中去掉著作权归作者所有，禁止商业用途转载。【原创内容，转载请注明出处】。）因此，维护类型文件的主要工作是前端。【转载请注明来源】【原创不易，请尊重版权】但是，这并不代表前端同学可以任意修改类型原创内容，盗版必究。【访问 www.tangshuang.net 获取更多精彩内容】文件，修改类型文件意味着对服务端返回结果【版权所有，侵权必究】【版权所有】唐霜 www.tangshuang.net的修改，但如果在后台同学未知情的情况下这【关注微信公众号：wwwtangshuangnet】【版权所有】唐霜 www.tangshuang.net样做，最终会出问题。当然，由于有了上述三【本文受版权保护】本文版权归作者所有，未经授权不得转载。个服务的保证，这个问题一般可以在开发阶段原创内容，盗版必究。原创内容，盗版必究。就反馈出来。

【本文首发于唐霜的博客】未经授权，禁止复制转载。【原创内容，转载请注明出处】

【未经授权禁止转载】转载请注明出处：www.tangshua本文版权归作者所有，未经授权不得转载。未经授权，禁止复制转载。ng.net

通过 git 管理类型文件，设置 hoo【作者：唐霜】原创内容，盗版必究。k，当类型文件更新之后，触发 CI 任务未经授权，禁止复制转载。【本文受版权保护】，将新的类型文件部署到服务器上，这样就可【作者：唐霜】【作者：唐霜】以完成上述 3 个服务的同时更新。

本文作者：唐霜，转载请注明出处。本文版权归作者所有，未经授权不得转载。

小结

本文基于 TySheMo 体系去解决接口【转载请注明来源】本文版权归作者所有，未经授权不得转载。的数据类型、Mock 等问题，是出于对实未经授权，禁止复制转载。原创内容，盗版必究。际工作中需求的思考，力求将整个解决方案做【原创不易，请尊重版权】【访问 www.tangshuang.net 获取更多精彩内容】到最小化，轻量化，随时可抛弃，而不影响原著作权归作者所有，禁止商业用途转载。本文版权归作者所有，未经授权不得转载。有的业务逻辑。当然，这里面还有一些问题尚【本文首发于唐霜的博客】【本文首发于唐霜的博客】未解决，如果你有兴趣，可以参与到该项目中，一起改进它。

【版权所有】唐霜 www.tangshuang.net转载请注明出处：www.tangshuang.net【未经授权禁止转载】【原创内容，转载请注明出处】著作权归作者所有，禁止商业用途转载。著作权归作者所有，禁止商业用途转载。【原创不易，请尊重版权】【作者：唐霜】著作权归作者所有，禁止商业用途转载。【原创内容，转载请注明出处】原创内容，盗版必究。【版权所有】唐霜 www.tangshuang.net转载请注明出处：www.tangshuang.net【作者：唐霜】本文版权归作者所有，未经授权不得转载。【关注微信公众号：wwwtangshuangnet】【关注微信公众号：wwwtangshuangnet】【版权所有，侵权必究】【原创不易，请尊重版权】【原创不易，请尊重版权】本文版权归作者所有，未经授权不得转载。【原创不易，请尊重版权】【版权所有】唐霜 www.tangshuang.net【本文首发于唐霜的博客】【本文受版权保护】本文作者：唐霜，转载请注明出处。【原创不易，请尊重版权】本文作者：唐霜，转载请注明出处。著作权归作者所有，禁止商业用途转载。著作权归作者所有，禁止商业用途转载。

2019-09-29 4721

唐霜

前端驱动的接口数据检查、文档生成、mock 以及自动化测试

类型模块

文档服务

Mock 服务

测试服务

统一维护类型

小结

为价值买单，打赏一杯咖啡

声明

关于

生态