6-5-前后端分离中 API 接口与数据 Mock 的思考与应用

前后端分离中API接口与数据

Mock的思考与应用关于我现任职于美团大众基础终端组在美团大众负责过考试系统的开发曾负责百度音乐FM，主站webapp的开发在Node工程工具和自动化方面有较丰富的经验联调的进化前后端分离时代模版时代串行开发时代模版传递数据前端必须等待API开发完成后才能开发开发者闲置率高项目高度耦合

项目间数据复用度低前后端并行开发时代的声音约定好的API又变了，半个月 之后我才知道这件事这么多mock方案我选哪个？公司这个服务的API上哪查文 档？文档写起来好费时写文档就够烦了，测试就免了 吧联调面临的现状大量项目选择前后端完全分离microservices大势所向广义上后端通常也是作为其他服务的前端广义的前端SSO服务网页端业务服务iOS端存储服务这里只有“存储服务”不作为广义前端广义的前端都可能需要mockSSO服务网页端12345业务服务iOS端存储服务1，2，3，4，5在开发初期都可能需要mock这是个充满轮子的世界SSO服务网页端手写轮子mock.js使用测试服务业务服务Nocilla手写轮子iOS端存储服务网页端、iOS端几乎无法复用API假数据轮子真的非常之多比如Github上的mock相关仓库就有1.3w个之多我不想造轮子，能不能用三方的方案？免开语言中流程自动单费源立控制元测试文档生文档多协议侵入用成共享支持户代码沙盒化o

o

x

x

x

o

x

x

0

omock.js总结现有轮子的常见问题各工具设计语言不中立，难以共享定义大多难以做到沙盒化难以确保API的可用性如何解决这些问题1.定义一次API而可以处处复用API定义中心化生成API文档流程约束API定义API

mockAPI单元测试只需要定义一次API即可自动完成API文档生成，mock假数据，单元测试API，以及流程约束2.沙盒化沙盒常常意味着CS架构类似于github和git的关系在封闭环境里也能持续测试平台仅用于共享，开发时可以脱离平台开发去中心化（沙盒化）发布API被开发程序联调客户端API平台安装API开发测试环境外部环境一般mock开发模式示意浏览器假数劫持业务接口服务代理流量代码注入mock接入API平台请求本地浏览器联调客户端劫持API剩余请求业务接口服务类似MIMT，客户端的接入完全透明，且语言中立如何确保API的可用性一般RD的API开发流程发送mock请求单测工具开发用服务检测返回是否正确8080端口需要费时间自己写测试，甚至费时去调试测试代码本身API测试接入API平台存API定义到本地发送mock请求联调客户端开发用服务检测返回是否正确开发服务依赖的其它API将API测试加入到CI过程通过把API测试过程加入到CI流程，保证 去掉mock后前端能无缝对接上后端流程控制API变更的递归通知项目成员间的Approve和Reject机制API依赖树锁定服务AAPI发生变化服务B服务C服务C服务D递归的检测API变化所带来的影响提升项目间协作效率共享API的定义通过定义我们可以轻松生成文档持续优化API相关的垂直搜索应用场景Vane联调平台举一个简单开发场景示例一些常被问的问题道理我都懂那API如何定义呢？adoc

(api

documentation)markdown超集渲染成文档RPC

Thrift利用code

block的语言声明语法如RPC几乎可以根据实际情况随意扩展有状态的API请求如何mock？每个API是有多个case定义的可以选中任一的case组成一个scenario我们并没有止步于此API线上监测服务调用将逐步RPC化从API调用的源头