如何优雅的使用Mock Server

news2024/11/24 14:50:43

事出有因

昨天跟同事讨论我们在用的rap2(一个集接口编写和mock server的开源项目)和刚上线了一个easy-mock的server，到底哪个好用。

我们主要讨论的点有个两个：接口的一致性、编码的无侵入性。

背景

自从前后端分离后，完成前后端的分工之后，大家就可以各司其职，并行开发。前后端的协议标准就是接口文档。前端的所有逻辑和展现全部依赖接口文档中规定的数据结构。所以接口文档就变成了开发过程的重中之重。

当然有一份文档也是不够的，前端开发页面逻辑调试、测试同学测试接口、接口文档不断的更新、接口复杂的返回情况等诸多问题，这就需要有一个Mock Server来帮忙。

更多的关于Mock内容的请大家自行Google了解不再赘述。

接口的一致性

接口文档，是整个开发过程中的约定和依据，所以同步更新文档也成为关键一环。

之前的办法

使用markdown维护一个文档，更新之后分发给大家；或者就是放到wiki来管理，每次更新到wiki上面，供大家来阅读。如果要Mock数据（easy-mock或者其他mock server），相关人员修改mock字段，更新完毕。

优雅的做法

在线编辑接口，实时保存，同步更新。例如采用Rap2（支持JSON复制，支持接口的移动复制），保存后就是接口文档，所有人实时更新，同时Mock数据自动更新。

编码的无侵入性

Mock 对代码的侵入越小，我们维护和开发的成本也越低。以 Vue-cli2.x生成的项目为例：

在工程中的config目录dev.env.js，配置开发环境下API数据来源地址

...
module.exports = merge(prodEnv, {
    NODE_ENV: '"development"',
    ENV_CONFIG: '"dev"',
    // BASE_API: '"dev server"',
    BASE_API: '"http://rap2.taobao.org:8080/app/mock/39"', // mock server
})

这样我们在开发过程中，用到axios，只需要根据不同环境编写一次代码即可

const service = axios.create({
  baseURL: process.env.NODE_ENV === 'production' ? process.env.BASE_API : '/api',
  ...
});

从Mock数据切换到Dev Server的API只需要注释一行配置文件代码，无需修改项目源代码。非常友好。

这时候我们再看easy-mock 跟rap2生成的Mock Url：

http://easy-mock.com/mock/5c08e554bd9f9c3a01c5abf6/api/info
=> host/mock/projectId/:path
 
http://rap2.taobao.org:8080/app/mock/45/GET/api/info 
=> host/app/mock/:repositoryId/:method/:path
复制代码

ps:后来发现rap2的url可以不带method，但是就是不能使用restful API这种根据method区分的接口了。

从生成的url来看，rap2中有:method的变量，若是要无缝切换需要更多的工作。无法直接替换BASE_API。如果在代码里拼接会有很大的代码侵入性。

所以考虑在工程层面进行优化：

在工程目录config目录中index.js中，可以设置代理来统一处理:method变量。在proxyTable对象中加入bypass方法，对每个通过代理的接口，处理request url成为一个合格的rap2 mock的url。

module.exports = {
  dev: {
    ...
    proxyTable: {
      '/api': {
        target: config.BASE_API.substring(1, config.BASE_API.length - 1),
        changeOrigin: true,
        pathRewrite: {
          '^/api': '/'
        },
        bypass: function (req, res, proxyOptions) {
          if (proxyOptions.target.indexOf('mock') !== -1) {
            const path = req.url.replace(proxyOptions.context, proxyOptions.context + '/' + req.method);
            // path => /api/GET/path
            req.url = path;
          }
        }
      }
    },

这样就能无侵入性的使用rap2了。