工作是这样的:
用的便是 Swagger UI 主动生成的那种接口文档,就像这种:

这种 Swagger UI文档我每次看着就头大,缺点多多
-
检查多级模型时要一级级点开 -
在接口数量变多的时分十分难用,连分类菜单都没有 -
提交参数为 JSON 的时分不能格式化 -
参数犯错的时分查找费事 -
回来成果不能折叠,长得无法看
时刻比较紧迫,我就依照他给的文档里的参数与呼应数据,写到了我的前端页面上,前端这边简略自测了一下就仓促上线了。
上线完当晚就炸了。。

页面上各种接口报错:
-
参数不存在
-
参数类型过错
-
接口不存在(是由于接口写错了)
老迈立刻过来找我俩,但是前后端各不相谋:
-
前端: -
后端:我吊你,你用之前不会测一测接口正不正常? -
前端:我为什么要测?你开发的接口,你自己意外好? -
后端:我怎样知道你要用什么样的数据!你要是略微测一下接口,能有这么多事?

归根到底是个本钱问题
这时分老迈很镇定,阻挠了我们的吵架。

老迈剖析了一下这次事端的主要原因:
-
1、后端大意了,一些接口没有写对,也忘掉调试了 -
2、时刻紧,前端没来得及彻底测接口
然后老迈说,这归根到底是个本钱问题。要是前后端测接口都特别简略便利,你们这个问题就不存在了嘛!
你们现在用的在线接口文档,功用简直为零。应该选一个功用愈加强壮的在线接口文档东西,直接在线就把接口调了,你们是不是就不会出这些问题了。
这个东西应该具有以下功用:
-
调试功用,前端能很便利地调试接口数据 -
代码生成功用,这样前端能够少写点代码,进步功率一起也进步了准确性 -
接口同步功用,接口文档必定要是最新的代码信息
我们纷繁允许,是啊是啊。

老迈说,我最近试了一款东西,就能够零本钱地处理你们这些问题!
然后他给我们看了一个神仙文档。
便是这个!!⬇️⬇️⬇️

为什么说它神仙呢?由于它浑身都是牛逼到不可的特性,比往常见到那些 API 文档不知道高到哪里去了。
在线调试
这个文档是用 Apifox
点击文档右上角的运转按钮,就会呈现“在线运转”的模块

这个界面上就能直接调试接口了!直接 1. 填参数,2. 选环境,3. 点发送,接口恳求就宣布去了!下面就有回来成果!底子用不着 Postman!更不必把 API 照着抄一遍!

我心想,假如其时上线之前,用的是 Apifox 的话,那简直是不会呈现事端:
-
参数不存在?我在线调试后取得数据了,经过比对我知道哪个参数不存在 -
参数类型过错?相同的,在线调试之后,经过比对,我知道哪个参数的类型是错的 -
接口不存在(是由于接口写错了)?调试的时分就报接口不存在了,第一时刻找后端~
主动生成
我跟老迈说,这个功用看起来是很强壮啊。但是要是上线时刻紧,谁有功夫去搞这么个接口文档啊,装备起来应该很费事吧?
老迈邪魅一笑。

他说,这个文档,是自!动!生!成!的!
只需把 Swagger 的 URL 填到 Apifox 里边去,Apifox 就会主动导入 API 界说,然后就能生成这个好用的文档!
后端随意改代码,前端随时能够在线调试!

生成恳求代码
后端说,不便是一个在线调试接口吗,也没有到神仙的境地嘛。
老迈说,你仍是太年青。

在这个在线文档页面上,还有一行了解的 icon。这是什么呢?

自!动!生!成!代!码!
点击对应的言语,就能直接生成恳求的代码!???
我挑选了 JavaScript 之后,竟然还供给了 Fetch、Axios、Jquery 等等恳求方法的代码???

我直接 copy 一下代码,粘进代码里就能用???
一个在线文档,卷成这样至于嘛???

生成模型代码
老迈说,别急,还没完。

API 文档嘛,都会有个“回来呼应”的模块,便是告知你后端吐出来的数据是什么类型什么长度等等。前端再写个数据结构把这些数据接着,然后放进页面里去。
在这个神仙文档里呢,“回来呼应”里也有个“生成代码”。

我点了一下,就弹出了这个框:

左面还能够挑选你生成代码的装备,包含:编程言语、命名风格、校验敞开等等。
我看了看,Java,C,C++,JS,Swift,Go,Python,TypeScript……基本上我知道的言语全都有。
怎样着?回来数据结构的代码也不必写了?仿制一下粘曩昔就行了?
我静静翻了翻它主动生成的代码,又关上了。
我感觉我自己写的 Java 代码还没它主动生成写的好。

云端 Mock
我说老迈,我理解了。我这就去下载 Apifox,下个迭代我就用这个在线文档。哦不,下个迭代我就逼后端用这个在线文档。
老迈说,急什么。等我说完。你知道云端 Mock 吗?
我说,云嘛,神仙都是要驾云的,这很正常。
老迈说你正常一点。云端 Mock,便是在 API 文档页面上就直接完成 Mock 服务,虚拟一个服务端出来。
我:???

老迈说,比方,我们要恳求一个银行的 API,银行必定不会让你随意恳求啊,都是要验证身份约束次数的。用这个 Apifox 呢,你就能够直接在接口文档上恳求 Mock 数据了,也不会约束你的次数,也不会收你的钱。
我说老迈,我们是不是跳得有点快。你驾云我跟不上的。
老迈说没有啊,我们不是在聊这个在线文档的特性嘛。你看,这里有测验环境、正式环境和云端 Mock 环境,你只需切换到云端 Mock 环境,恳求就会发给 Mock 服务器了,跟正式环境调试相同相同的。

我:!!!!!
还能够这样??
老迈又用浏览器打开了这个 URL(https://mock.apifox.cn/m1/1035644-0-default/users/2),说你看,直接拜访 URL 就能获取到 Mock 数据了,你们前端用起来是不是很爽?

我猛允许。

这个时分,后端说,那是不是我们直接把常用的那些第三方 API 都做成这种能云端 Mock 的 API 文档,然后开发就都能直接调试第三方接口了?连 Mock 服务器都不必架?
我:

API Hub
老迈说,你们啊,too young too simple,sometimes naive.
给你们看个东西。

这个,叫做 API Hub。

在 Apifox 里边,现已把这些最常用的第三方 API 都做好了!即时通讯的,电商的,查快递的,项目办理的,通通都有!每一个都能够在线运转!生成代码!也能够克隆到自己的项目里,然后用云端 Mock!

老迈说,人家都把接口文档公开出来了,你们也好好学学人家大厂的接口是怎样规划的。哦对了,我们公司有接口要公开出去的话,也能够发布到这个 API Hub。

老迈说,好了,我说完了。你们都听懂了吗?
我说,懂了,明日就去跟后端对线。

后端说,等什么明日!我现在就要!
Apifox
最终,老迈苦口婆心地说,年青人啊,仍是要多学学先进技术和东西。
Apifox = Postman + Swagger + Mock + JMeter。集接口文档东西、接口 Mock 东西、接口主动化测验东西、接口调试东西于一体,提高 10 倍研制功率。

在这些中心功用之外,Apifox 还供给了很多立异的环绕 API 的扩展特性,合适各种规划的开发团队运用。

并且我看他们官方还有预告,后续会支撑更强壮的文档功用,包含自界说域名、自界说导航、多主题款式挑选、自界说 css、自界说页面
下载链接:http://apifox.cn/a101lbqcxy
或许,仿制上面链接,去官网下载吧