前后端分离开发模式的 mock 平台预研

// $.ajax({
//   url: ‘https://cntchen.github.io/userInfo’,//   type: 'GET',//   success: function(dt) {
    var dt = {
      "isSuccess": true,"errMsg": "This is error.","data": {
        "userName": "Cntchen","about": "FE"
      },};
    if (dt.isSuccess) {
      render(dt.data);
    } else {
      console.log(dt.errMsg);
    }
//   },//   fail: function() {}
// });

优点

可以快速修改测试数据

痛点

无法模拟异步的网络请求，无法测试网络异常
肮代码，联调前需要做较多改动，增加最终上真实环境的切换成本
-- 添加网络请求，修改接口、添加错误控制逻辑
接口文档变化需要手动更新

请求拦截 & mock 数据

hijack（劫持）接口的网络请求，将请求的返回替换为代码中的 mock 数据。

实例

jquery-mockjax

The jQuery Mockjax Plugin provides a simple and extremely flexible interface for mocking or simulating ajax requests and responses

优点

可以模拟异步的网络请求
可以快速修改测试数据

痛点

依赖特定的框架，如Jquery
增加最终上真实环境的切换成本
接口文档变换需要手动更新

本地 mock 服务器

将 mock 数据保存为本地文件。在前端调试的构建流中，用 node 开本地 mock 服务器，请求接口指向本地 mock 服务器，本地 mock 服务器 response mock 文件。

mock 文件

.mock
├── userInfo.json
├── userStars.json
├── blogs.json
└── following.json

接口调用

https://github.com/CntChen/userInfo --> localhost:port/userInfo

优点

对代码改动较小，联调测试只需要改动接口 url
可以快速修改测试数据

痛点

json 文件非常多
接口文档变化需要手动更新

代理服务器

使用 charles 或 fiddler 作为代理服务器
使用代理服务器的 map（映射）& rewrite（重写）功能

map local

接口请求的返回映射为本地 mock 数据
https://github.com/CntChen/userInfo --> localPath/userInfo

编辑映射规则

map remote

接口请求的返回映射为另一个远程接口的调用

rewrite

修改接口调用的 request 或 response，添加/删除/修改 HTTP request line/response line/headers/body
解决跨域问题
使用 map 后，接口调用的 response 不带 CORS headers，跨域请求在浏览器端会报错。需要重写接口返回的 header，添加 CORS 的字段。

优点

前端直接请求真实接口，无需修改代码
可以修改接口返回数据

痛点

需要处理跨域问题
一个变更需要代理服务器进行多处改动，配置效率低下
不支持 HTTP method 的区分
-- CORS 的 preflight 请求(OPTION)也会返回数据
需要有远程接口或本地 mock 文件，与使用本地 mock 文件相同的痛点

mock 平台

接口文档服务器

使用接口文档服务器来定义接口数据结构

mock服务器

mock 服务器根据接口文档自动生成 mock 数据，实现了接口文档即API

优点

接口文档自动生成和更新 mock 数据
前端代码联调时改动小

缺点

可能存在跨域问题

业界实践

公司实践

没有找到公司级别的框架，除了阿里的 RAP。可能原因：

非关键性、开创性技术，没有太多研究价值
许多大公司是小团队作战，没有统一的 mock 平台
已经有一些稳定的接口，并不存在后台接口没有开发完成的问题
-- 而我们想探究的问题是：前后端同时开发时的 mock

github 开源库

faker.js
随机生成固定字段的 mock 数据,如email，date，images等，支持国际化。
blueprint

A powerful high-level API design language for web APIs.

一种使用类markdown语法的接口编写语言，使用json-schema和mson作为接口字段描述。有完善的工具链进行接口文件 Edit，Test，Mock，Parse，Converter等。

swagger

Swagger是一种 Rest API 的简单但强大的表示方式，标准的，语言无关，这种表示方式不但人可读，而且机器可读。可以作为 Rest API 的交互式文档，也可以作为 Rest API 的形式化的接口描述，生成客户端和服务端的代码。 --Swagger：Rest API的描述语言

定义了一套接口文档编写语法，然后可以自动生成接口文档。相关项目: Swagger Editor ，用于编写 API 文档。Swagger UI restful 接口文档在线自动生成与功能测试软件。点击查看Swagger-UI在线示例。

wireMock

wiremock is a simulator for HTTP-based APIs. Some might consider it a service virtualization tool or a mock server. It supports testing of edge cases and failure modes that the real API won't reliably produce.

商业化方案

apiary
商业化方案，blueprint开源项目的创造者。界面化，提供mock功能，生成各编程语言的调用代码(跟 postman 的 generate code snippets类似)。

其他实践

API Evangelist(API 布道者)

总结

对于前后端分离开发方式，已经有比较成熟的 mock 平台，主要解决了2个问题：

接口文档的编辑和维护
接口 mock 数据的自动生成和更新

后记

预研时间比较有限，有一些新的 mock 模式或优秀的 mock 平台没有覆盖到，欢迎补充。
笔者所在公司选用的平台是 RAP，后续会整理一篇 RAP 实践方面的文章。
问题来了：你开发中的 mock 方式是什么？

References

图解基于node.js实现前后端分离

http://yalishizhude.github.io...

TestDouble(介绍 mock 相关的概念)

http://martinfowler.com/bliki...

There Are Four API Design Editors To Choose From Now

https://apievangelist.com/201...

联调之痛--契约测试

http://www.ituring.com.cn/art...

Swagger：Rest API的描述语言

https://zhuanlan.zhihu.com/p/...

Swagger - 前后端分离后的契约

http://www.cnblogs.com/whitew...

Swagger UI教程 API 文档神器搭配Node使用

http://www.jianshu.com/p/d662...

前后端分离开发模式的 mock 平台预研

引入

背景

前后端分离

开发流程

面临问题

解决方法

接口文档服务器

功能

接口编辑功能

接口查看功能

用法

优点

前端 mock 方法回顾

硬编码数据

示例

优点

痛点

请求拦截 & mock 数据

实例

优点

痛点

本地 mock 服务器

mock 文件

接口调用

优点

痛点

代理服务器

map local

map remote

rewrite

优点

痛点

mock 平台

接口文档服务器

mock服务器

优点

缺点

业界实践

公司实践

github 开源库

商业化方案

其他实践

总结

后记

References

END

相关文章