聊城商城网站建设,百度快速排名,价格低速度快很多人喜欢来这翻译,提高网站建设管理水平随着互联网的发展#xff0c;API变的至关重要。根据统计#xff0c;目前市面上有上千万的开发者#xff0c;互联网项目超过10亿#xff0c;保守统计涉及的 API 数量大约有 100 亿。这么大基数的API#xff0c;只要解决某些共有的痛点#xff0c;将会是非常有意义的事情。…随着互联网的发展API变的至关重要。根据统计目前市面上有上千万的开发者互联网项目超过10亿保守统计涉及的 API 数量大约有 100 亿。这么大基数的API只要解决某些共有的痛点将会是非常有意义的事情。我们总结了API管理方面的问题发现与API相关的文档调试测试和数据Mock 在工作中效率是非常低下的。
业务痛点 接口的维护管理非常耗时大概占用了30%开发时间。后端程序员要维护对于他们冗余的文档前端程序员又因为后端开发提供的文档不准确导致浪费了大量的时间。
接口的正确性和稳定性很难保证前端工程师为了处理各种数据异常情况将会写大量异常处理逻辑。传统的接口自动化测试成本非常高开发一个接口可能只需要一天但写接口测试用例需要花费好几天的时间。
对于前端程序员在后端功能没有开发完成之前他们需要接口返回数据 Mock 以便不影响开发进度。传统的数据 mock 是把模拟数据写到项目代码里这么做会带来更多新的问题首先后端程序员定义的接口随着需求、架构涉及随时发生变化的如果前端程序员完全按照最初的设计定义mock数据将会和实际做出来的接口有很大的出入。
没有一个标准化的流程统一处理这个过程是非常分散的需要配合非常多的工具效率比较低。
市场产品调研
我们期望有一个完整的接口工具协助开发人员在简单易用的GUI界面调试管理文档和测试接口。于是开始寻找市面上类似产品经过一段时间的分析最终我们找到了几个比较有代表性的产品 RapNeiEasy-Mock。同时我们按照自己的诉求列出了一些关键的特征 Nei 是网易前端事业部的产品在这些产品中算是做得比较好的 nei 专注做 saas 服务这块没有开源版本。对于去哪儿内部肯定不会把公司机密的接口数据放到第三方平台。
Rap 是阿里妈妈 MUX 团队2013年出的一款产品从时间上看是同类产品中最早的。Rap 是后端工程师基于 java 开发的如果想定制部分功能还需要学习 java而我们部门大家对 java 都不熟悉。另一方面 Rap 没有接口测试功能而后端使用其他工具postman restlet测试接口前后端开发人员没有使用的统一工具。
Easy-Mock 是大搜车无线团队出的一款产品Easy-Mock 定位是接口数据的模拟解决前端依赖后端接口数据的问题在同类产品中 mock 服务做得比较好。Easy-Mock 专注于前端数据的模拟但无法解决去哪儿现有的问题。
Rap 和 Easy-Mock 只是针对开发人员的单一工具他们只关注了开发流程某一方面并没有站在全局的角度去解决问题我们的目标是整合接口开发过程中的工具。所以我们开始自主研发一个全新的接口管理平台我们希望它能够提供接口文档管理接口数据模拟Mock接口调试自动化测试等功能让前后端接口相关的工作进行的更加高效。这就是 YApi 接口管理平台斐然由来。下面聊聊 YApi 是如何解决上述的痛点。
解决方案
共同维护一份接口定义打通各个环节 在后端开发接口过程中开发和测试是必不可少的环节。如下图所示按以往的做法接口文档管理因为没有跟开发和测试整合到一起被孤立导致后端维护对于他们冗杂繁琐的文档是件收益很低的事情。没有人喜欢做收益低的事情只有提高了维护接口文档的收益才能真正解决这个问题。
在接口开发过程中后端通常都会使用 postman 等类似的工具测试接口而测试接口是在开发过程中一个必要的过程。如果参数有改动必然会在 postman 等工具上更新字段和测试接口。由此可以联想到 如果能有一款工具既可用来做测试接口又能作为接口文档工具将接口文档和接口测试连接到一起不就解决了此问题。YApi 解决方案是将接口文档和测试通过单一数据源连接到一起如果有改动因为改的是单一的数据源就不会出现更新滞后和不及时问题。 前端 Mock Server 方案
数据 Mock 服务在开发前期是比较棘手的问题。大多数情况下接口请求参数和返回数据都是后端规定的在后端接口没有完成之前接口对于前端就是一个黑洞可能最初对接口的定义跟实际后端做出的接口会有非常大的不同。这个时候就需要有一个工具不仅能模拟真实接口的情况还能关联接口文档在后端开发过程中可以随时调整接口定义并通知给前端开发者改动信息。
在 YApi 平台前后端只要维护接口定义的响应数据就可以生成需要的模拟数据下面这段代码定义了生成数据模板
{errcode: 0,errmsg: string,data: {type:pick(1,2,3),list|1-10: [{uid: id,username: name}]}
} 可生成如下的模拟数据
{errcode: 0,errmsg: ^*!SF)R,data: {type: 2,list: [{uid: 370000200707276255,username: Ruth Clark},{uid: 650000200211185728,username: Anthony Martin},{uid: 370000199201143855,username: Laura Rodriguez},{uid: 610000198704072775,username: Anthony Perez}]}
} 以往的数据 mock 方案难免会影响项目源码yapi 使用了服务器代理的方案只需要在你的开发机做下服务器反向代理配置不用修改项目一行源代码即可获取到所有的 mock 数据。
基础的 Mock 工具已经能满足大部分的需求了但有些复杂场景是无法实现的。例如当我做一个数据列表页面需要测试某个字段在不同长度下以及数据为空时页面交互。YApi 提供了期望和自定义脚本的功能。
自定义脚本
自定义脚本可根据请求的参数cookie 信息使用 javascript 脚本自定义返回的数据。我们假设有个场景我希望通过 cookie _type 控制列表页面数据显示假设 _type 是 error那么列表显示异常错误信息假设 _type 是 empty 列表显示为空。可使用下面代码实现
if(cookie._type error){mockJson.errcode 400;
}if(cookie._type empty){mockJson.data.list [];
}3.自动化测试
接口开发完成后后续的迭代是非常多的每次对源码的修改都需要大量的测试才能确保接口是否正确。人工判断肯定是不好的最好的办法做成自动化测试但自动化测试又是一件成本非常高的事情需要后端人员和QA人员学习相关的框架和写大量的代码。
YApi 的目标是通过简单的 GUI 界面就算不懂程序开发只需配置相关的参数和断言语句就能实现自动化测试非常的易用。除了基本的功能外YApi 还提供了强大的 Pre-Script 和可视化表达式功能。
Pre-Script
Pre-Script 包括请求参数处理脚本和响应数据处理脚本两部分。通过自定义 javascript 脚本方式改变请求的参数和返回的 response 数据。他的使用场景如下
接口请求参数需要加密及返回 response 解密接口请求参数需要添加计算 token
可视化表达式生成器
可视化表达主要是为了方便用户生成自动化测试所用到的参数通过一个树形选择性快速引用所依赖的参数值。在所有的需要测试的接口配置完成后点击开始测试就会按照指定的顺序依次测试所有接口测试完成后可查看测试报告。
4.插件机制
业务的需求是层出不穷的YApi 作为一个面向全国所有开发者的工具不可能集成所有开发者需要的功能。我们参考了极简产品设计理念保持内核的简洁性通过灵活强大的插件机制满足各类业务的需求。目前YApi的第三方登录swagger、postman 数据导入等功能都是基于插件机制实现。
成果
YApi 在公司内部去年十月份上线后不到一周时间就有超过 700 个开发加入并使用 YApi 管理接口。目前公司内部已有将近300个项目使用 YApi 管理平均每天的接口 mock 次数超过了5000。本着开源精神让 YApi 提高更多开发者的效率我们的YApi 在 github 开源了目前已有 1.6 k star全国将近 500 家公司使用 YApi 管理他们的接口包括一些大家耳熟能详的公司如百度京东链接快手艺龙唯品会等等
