乐趣区

关于后端:接口文档生成工具ApiPost-绝了

作为一名程序员我深知一款好用的软件工具对工作效率的晋升意味着什么,置信不少程序员还在依附老外们做的软件解决手头工作,已经我也是其中一员,不过当初我曾经开始迷上了国产软件,国外的天然后他的劣势,但国产软件工具也吸引了不少程序员开始尝试,尽管他还有这样和那样的有余,然而做为一名土生土长的中国程序员,我还是置信自家造的货色的,举个栗子就好比最近在用的 Apipost 就是一个值得举荐的好工具。

或者咱们不少做编程的敌人可能还在应用 postman、swagger、mock 等工具吧,你可曾晓得这类软件在国内曾经悄悄的倒退起来了,而且多是集成了多种软件性能,不能满足多种利用场景,还进步了工作效率,其实这类软件不止 Apipost,但为什么我要挑它来讲呢? 重要是因为它不仅能够模仿发送 get、post、delete、put 申请,还能够导出文档,反对团队合作。

要晓得对于 postman 等国外软件来说,咱们是有应用老本的,不仅工位绝对较贵,而且对于国内程序员来说有些吃力,尤其是针对英语不太好的敌人们,是不是的就得用用有道词典吧?ApiPost 本人人做的软件更适宜合乎国内程序员爱好。下边给大家分享两个我认为很好用的性能。

1、一键生成文档

咱们在“2 分钟玩转 APIPOST”一讲中,简略介绍了如何生成并分享接口文档:

点击分享文档

复制并打开文档地址就能够看到了残缺的接口文档。

本节课次要是解说一些须要留神的事项。

申请参数的形容填写

对于 header、query 以及 form-data 和 urlencode 的 body 参数,咱们在如下中央填写参数形容:

如图中所示,对于一个填写过的参数,咱们能够在新建接口能够通过点击参数形容前面的♦️方块标记疾速导入形容,不必反复打字。

对于 raw 类型的 body 参数,咱们能够通过点击“提取字段和形容”来针对参数进行形容的填写:

对于曾经填写过的参数,APIPOST 会主动匹配形容,不必反复填写。

响应参数的形容填写

很多老手困惑为什么 APIPOST 分享的文档没有胜利响应示例和谬误响应示例,那是因为 APIPOST 不会把发送后的实时响应的数据作为响应示例。

您须要手动的将实时响应后果导入或者复制到对应的胜利响应示例和谬误响应示例。

字段形容的填写跟 raw 类型的 body 参数,咱们能够通过点击“提取字段和形容”来针对参数进行形容的填写。

同样,对于曾经填写过的参数,APIPOST 会主动匹配形容,不必反复填写。

2、

参数形容库

填写参数形容是咱们最懊恼的一件事件,尤其对于很多接口来说,往往具备大量雷同名称、雷同意义的参数,如果每次都须要手动录入,将会是一件十分耗时、低效的事件。

咱们能够通过参数形容库解决这个问题。

在这里插入图片形容

参数形容库的应用

通过自定义参数形容库,咱们能够将本我的项目用到的大量参数进行预正文:

咱们也能够通过导入参数形容性能,将数据库定义的字段正文疾速导入到 APIPOST 的参数形容库中。

疾速导入参数形容

这样咱们在填写参数形容的时候,针对已定义的参数,咱们能够间接疾速导入参数形容:

看看,如许好的软件呀,刚开始用的时候的确让我眼前一亮,除此之外 Apipost 还有很多好玩的性能期待着你去发现,那怎么下载安装呢?

链接:https://console.apipost.cn/re…

最初想说的是无论是 postman 还是 Apipost 都有人喜爱,正如咱们常常说的那句话,萝卜白菜各有所爱,不过就集体教训来看,Apipost 必将是将来趋势,本人家的软件用起来更平安,国产的工具操作起来也肯定更棘手!

版权申明:本文为 知乎 博主「加瓦搬砖 123」的原创文章。
原文链接:https://zhuanlan.zhihu.com/p/…

退出移动版