关键词：
大家好，我是小孟，最近做了不少项目，后面会路线开源给大家。
做的这些项目的过程中，发现了一款接口文档的神器。
喜欢尝鲜的小伙伴可以纳拿去使用，可以找小孟一起交流呀。
也希望大家的技术一样棒棒的，然后搞点私活，香的狠！
文章目录
痛点
如果你负责测试的项目是一个前后端分离的项目。
回忆下是不是有如下场景:
某个项目开发完成,接口文档发布在了swagger上,前后端各自进行开发。
此时你负责这个项目的服务端测试。
首先进行接口测试,熟练的打开postman导入swagger文档,然后开始进行接口测试。
接口测试完成后,准备开始性能测试。又要将swagger接口文档的新接口迁移到jmeter上，然后开始编写压测脚本。
某个项目在测试中,由于后端修复bug改了接口参数,此时你进行接口回归测试,发现接口测试脚本失败,此时给开发提了一个bug。
开发跑过来给你说,接口文档有变动忘了和你说了,此时你只能默默的修改接口测试用例。
服务上线一段时间后。某天,新员工开发小黄想想看下这个项目之前的接口文档,发现测试环境接口swagger地址打不开了,没有地方可以看接口文档。
其实上边这些问题,在日常工作中很常见。其根本原因是接口文档缺乏统一管理,有的团队喜欢把接口文档写在内部协作文档平台里、有的团队喜欢写在 git 代码仓库里,它们的存放目录及目录深度各有不同。当后来人想要看接口的历史文档时,无从查起,许多文档就这样遗失了。
你有没有想过拥有一个,可以同时解决数据同步、调试、Mock、自动化测试的接口文档管理工具。
什么是eolink
结合 API 设计、文档管理、自动化测试、监控、研发管理和团队协作的一站式 API 生产平台，从个人开发者到跨国企业用户，Eolink 帮助全球超过30万开发者和数万家企业更快、更好且更安全地开发和使用 API。
为什么选eolink
支持 HTTP(S)、Websocket、TCP、UDP 等主流协议，通过代码注解自动生成 API 文档,或者从 API 文档反向生成所有常见开发语言和框架的代码，节省 API 设计和开发时间。强大的 API 版本和变更管理让你不放过 API 的任何变动。
- 支持所有主流协议
- 代码自动生成 API 文档
- API 文档自动生成代码
- API 版本管理
- API 变更通知
超方便的 API 测试
支持多种方式快速发起 API 测试，自动生成随机测试数据和测试用例，一键对 API 进行批量回归和冒烟测试，并且立刻得到丰富详细的测试报告，让繁琐的 API 测试变得如此简单。
- 支持在线、本地、客户端进行测试
- 一键进行回归/冒烟测试
- 快速创建测试用例
- 自动生成测试数据
- 丰富详细的测试报告
0代码的 API 自动化测试
不需要编写代码,通过拖拉拽即可创建 API 测试流程，API 文档和测试步骤自动关联，当 API 文档发生变化时自动同步到测试用例，极低的学习和维护成本。并且通过定时自动测试将测试报告推送到邮箱、钉钉、企业微信、飞书、Jenkins 等平台，与 CI/CD 流程无缝结合。
- 与 API 文档关联与自动同步
- 0代码，拖拉拽完成测试流程编排
- 统一管理测试数据
- 对数据库进行操作
- 定时自动测试
- 测试报告自动推送
eolink初体验
我们看一下eolink是如何使用接口文档管理工具、接口文档生成工具这两个功能。解决日常工作中,涉及接口文档变更问题。
安装注册
eolink是跨平台的工具,支持macOS(Intel+M1)、Linux、windows(32位、64位),在官网 , 选择对应系统的安装包下载安装即可用。
首次使用注册账号就可以使用。登录eolink后,可以看到左侧的项目、环境、高级功能。点击项目,可以看到API文档管理。
接口文档管理
eolink支持多种导入数据方式,比如swagger、jmeter、yapi、rap等常用接口测试工具,这里我们沿用使用swagger工具导入数据,其他工具导入的方式也大同小异,后续再介绍。
导入接口数据后的接口列表展示效果,可以看到接口名称、接口路径、协议等参数。
随便点击一个接口,可以看到基本信息、请求参数、响应内容。
点击修改文档/新建接口,可以编辑接口的信息。点击保存,可以触发消息通知给相关人员。
自动同步接口
在研发过程中,开发人员修改代码,重启服务后swagger工具会自动更新,但是eolink中还是旧的接口数据,这就会导致接口文档不及时更新的问题。
在eolink可以通过代码注解或者其他工具自动生成或抓取API文档,是怎么做到的呢?
输入项目的swagger地址,数据同步方式选择增量更新,这样做的好处是在旧接口文档的基础上增量修改,避免了重复新增接口数据。
在线接口文档
根据定义好的接口,生成可以通过浏览器访问的web地址分享给其他人。
在线接口文档适合提供给本地没有安装eolink客户端的用户,方便大家随时可以查看接口信息、进行接口测试。
另外在设置分享页面,设置可见项目环境、设置分享的功能模块，例如 Mock、API 测试、API 测试用例等等。
接口调试
当我们设计好接口测试用例之后，可以调试看看效果。
以查询商品接口为例，进入执行页面，填写完成参数值，选择运行环境，点击运行即可发起一个简单的请求，页面下方可查看接口响应、请求详情。
接口调试参数可以保存为一个接口测试用例用例，方便下次调试或者团队成员测试使用。
执行接口参数用例的目的是验证不同测试场景下接口的正确性，例如密码错误、用户名非法、参数值空等等。
如果需要从响应提取信息以供后续请求使用，通过可视化 UI 操作即可0编码实现提取变量和对返回值断言的操作。
入口在后置操作里面，我们从响应提取一code存为环境变量，并断言响应里的code字段值为"200"。
可以查看内置函数手册,使用内置函数进行断言,如果接口返回格式是json格式,可以使用jsonpath获取需要的字段值,进行断言。
后置脚本例子,获取code字段参数:
var info = eo.http.response.get("info")
var code = eo.jsonpath("code",info);
eo.info(code);
if(code !=200)
eo.error("接口断言失败");
丰富的内置函数,基本上满足日常测试工作要求,包括: 单接口测试、串联接口测试。
总结
随着项目不断的迭代,项目也越来越复杂。带来的问题是,接口入参和出参会不断地新增、修改。
测试人员面临的挑战是:
1、如何获取最新的接口文档
2、如何降低接口测试的成本
3、如何提高团队协作的效率
eolink既能管理接口又能做自动化测试、好用好看还免费的接口文档工具, 还不赶紧用起来~
上面就是小孟三天搞一个项目，这么神速的原因，因为开发有神器呀。
我发现了一款高效管理接口文档的神器(代码片段)
...f0c;后面会路线开源给大家。做的这些项目的过程中，发现了一款接口文档的神器。喜欢尝鲜的小伙伴可以纳拿去使用，可以找小孟一起交流呀。也希望大家的技术一样棒棒的，然后搞点私活，香的狠！文章目... 查看详情
❤为了帮粉丝完成毕业设计，我发现了一款私活神器！！(代码片段)
作者：不吃西红柿简介：CSDN博客专家、蓝桥签约作者、大数据领域优质创作者。【创作不易，求点赞、求收藏】一、缘起 不日前，有粉丝找到我，让我帮着做个： 教师管理系统由于种种借口，我当... 查看详情
一款api测试神器，非常强
...地问对接方这是啥意思，最后终于调通了一次，发现环境写错了…今天偶然间发现了一款工具，看它官网中的中文页面，倍感心切，很干净。尤其是里面的状态码管理，很能解决痛点。打算给项目组成员普... 查看详情
推荐一款神级api接口管理神器
...、滴滴的开发朋友提到ApiPost，自己体验操作后，发现它的优势的确明显。二、ApiPost简介ApiPost官方网站下载地址 查看详情
推荐一款神级api接口管理神器
...、滴滴的开发朋友提到ApiPost，自己体验操作后，发现它的优势的确明显。二、ApiPost简介ApiPost官方网站下载地址 查看详情
推荐一款前后端协作开发神器apipost：postman+swagger+mock的复合体(代码片段)
...家好，我是路飞！今天这篇文章，给大家介绍一款非常好用的国内软件自研发的开发辅助软件ApiPost！作为一个名服务端开发者，我们在日常工作中离不开接口测试、接口文档编写、Mock数据测试、前后端接口联... 查看详情
用了国产接口管理神器apifox之后，我果断从postman“脱坑”了(代码片段)
...First理念下的开发流程二、上手操作Apifox1.安装Apifox2.团队管理&项目管理3.编写接口文档4.智能Mock数据5.在线分享API文档6.自动化测试7.APIHub三、Apifox电梯直达一、认识Apifox1.为什么要使用Apifox工具在当前行业发展背景下，绝... 查看详情
公司自用的国产api管理神器(代码片段)
1、前言虚竹哥从事后端开发，平时写的后端接口，是以swagger生成API接口文档，提供给前端调用，与前端交互的文档；然后用Postman自测接口，有些性能要求的接口会用JMeter进行接口性能测试。有时开发前端... 查看详情
公司自用的国产api管理神器(代码片段)
1、前言虚竹哥从事后端开发，平时写的后端接口，是以swagger生成API接口文档，提供给前端调用，与前端交互的文档；然后用Postman自测接口，有些性能要求的接口会用JMeter进行接口性能测试。有时开发前端... 查看详情
还在发愁写api文档？推荐一款阿里腾讯都在用的api管理神器
...于付出的成本，无非两个方向：鉴于此，我们设想如果有一款工具做到以下这些是不是就非常爽了？总结下来，我们需要的就是这么一款工具：为此，我们几乎尝遍了市面上所有相关的工具，但是很遗憾，没有找到合适的。于是... 查看详情
jetbrains又出了一款新神器，一套代码适应多端！(代码片段)
看到一款基于多端的UI调试工具，一套代码适应多端，真的是太棒了，下面分享给大家。1、前言该工具是大名鼎鼎的JetBrains公司新推出的，名曰：“JetpackComposeforWeb”，官方介绍称此项目基于Google现代UI工... 查看详情
推荐一款管理系统专用低代码工具，一天开发一个系统不是梦！(代码片段)
...前写过一篇关于阿里的低代码工具LowCodeEngine的文章，发现大家还是挺感兴趣的。最近又发现了一款很有意思的低代码工具Yao，支持使用JSON的形式开发管理系统，不仅可以用来开发后端API，还能用来开发前端界面&#... 查看详情
再见postman，我选择apipost(代码片段)
最近身边一批大神都在向我推荐一款神器：ApiPost。这是一款支持模拟POST、GET、PUT等常见HTTP请求,支持团队协作，并可直接生成并导出接口文档的API文档、调试、Mock、测试一体化协作性能非常强大的工具。简单说：ApiP... 查看详情
测试接口直接生成api文档，这个工具贼好用(代码片段)
有啥好用的API文档工具推荐，无意间发现了一款工具，这里马不停蹄的来给大家分享一下。ShowDoc一个非常适合团队的在线API文档工具，也支持用docker自建文档服务，不过为了方便演示，我直接用了平台在线服... 查看详情
我最近在用的一款神器，功能多到炸！
...期不写文档或者随便一些，当需要去写的时候，发现无从下笔，写作可太难了!!!而接口文档的要求相对来说较高，不仅需要内容详实，把问题讲清楚，还需要有清晰的层级结构，让其他读者快速获取到... 查看详情
技术必备：推荐一款接口自动化测试数据校验神器(代码片段)
大家好，我是狂师。在之前分享中，给大家介绍过一篇：如何快速审核接口返回值全部字段解决方案，详见原文：接口自动化测试，一键快速校验接口返回值全部字段。当时，提到解决这类问题，市面上常见的解决方案有两种：... 查看详情
还在用swagger？我推荐这款零代码侵入的接口管理神器！(代码片段)
静态的Swagger们跟不上频繁变更的代码“为什么改了这个没告诉我”,“实际功能和文档上说的不一样啊”。这些话大家做开发的想必耳朵都听出老茧了。真不是故意的，有时候任务比较急，就先改了代码，想着以后再... 查看详情
前后端分离接口管理神器——rap本地搭建
我这里要用做mockserver的就是rap了，rap结合了团队管理，项目管理，文档编写、Mock.js、可视化、接口过渡、文档历史版本（赞）、mock插件（线上线下切换就只需要注释一句代码就OK），支持本地部署。由于官网讲解的太模糊... 查看详情