还在随大流用PostMan,快来试试Apipost吧(下)

发表于:2022-6-14 09:22

字体: | 上一篇 | 下一篇 | 我要投稿

 作者:上分如喝水    来源:稀土掘金

  核心亮点功能
  生成文档是Apipost的另一个重要功能,接口文档的撰写非常麻烦,而且很多属于重复工作,效率低下。我们写接口文档一般会采用Swagger来自动生成接口文档,但是这个接口文档侵入性太强了,在代码里面要写大量的注解和配置,有没有一键就可以自动生成漂亮、规范的文档的软件呢?
  有!Apipost提供了自动生成文档的功能,我们写好了接口以后,只需要点击一键分享按钮,就可以自动生成接口,并且可以自定义分享有效期及权限,这是绝大多数的接口文档生成工具做不到的。
  1、核心亮点功能
  点击这个分享文档按钮即可生成在线的接口文档。
  如果你的接口文档是不想公开的话是可以设置权限的,目前是可以通过密码去区分权限。
  同时支持随机密码和自定义密码。如果你比较懒就随机密码,如果你比较精致,就自定义密码。
  我们将这里的外网链接复制到浏览器中访问就可以看到美观的接口文档了。
  他大致长这样,比Swagger美观和简洁很多。
  如果你想要导出到本地的话,还可以以三种方式去导出,这个产品直接给满分好吧。
  2、参数库描述
  在一般的前后端分离模式的开发中,前端如果想了解后端的参数的含义一般都是通过接口文档,所以这个时候接口文档的参数表达就显得格外重要了。Apipost支持给每个参数快速写一简单的注释,让前端在看到接口文档的时候可以快速知道这个参数所代表的含义。
  添加了参数描述以后的接口文档就变得更健壮也更简洁易懂,十分契合团队协作开发。
  不知道各位开发大佬有没有一种感觉,有些时候参数的描述是非常重复的,比如说username就表示登录的用户名,password就表示密码,很多的时候会重复写很多次,真的是很苦恼。Apipost提供了一个参数描述库的功能,对于一个填写过的参数,我们可以在新建接口可以通过点击参数描述后面的按钮快速导入描述,不用重复打字,对于已经填写过的参数,Apipost会自动匹配描述,不用重复填写。
  对于一些常见的参数,我们可以把他们录入到参数描述库里面去,下次使用可以直接使用了。
  我测试了几个接口下来,挺实用的,毕竟很多的时候参数名重复确实可以剩下不少的时间。
  总结
  整体体验下来,APIPOST我还是挺满意的,作为一款转为国人设计的软件,可以说是有挺多的亮点:
  ·客户端脱机且无需登录也可以使用。
  · 一键快速生成开发文档。
  · 参数描述库的出现减少了很多机械重复工作
  · 各种小细节(自动生成模拟代码、文档区分权限等)直接拉满。
  · 等等
  作为一款国产的API研发协同一体化平台,仅仅诞生两年,各方面功能和体验做的还是十分不错的,是一个后起之秀,他仅仅才2岁(诞生2年),未来还是有很大的修改和提升的空间,相信在未来,APIPOST会变成一款主流的软件。

  本文内容不用于商业目的,如涉及知识产权问题,请权利人联系51Testing小编(021-64471599-8017),我们将立即处理
《2023软件测试行业现状调查报告》独家发布~

关注51Testing

联系我们

快捷面板 站点地图 联系我们 广告服务 关于我们 站长统计 发展历程

法律顾问:上海兰迪律师事务所 项棋律师
版权所有 上海博为峰软件技术股份有限公司 Copyright©51testing.com 2003-2024
投诉及意见反馈:webmaster@51testing.com; 业务联系:service@51testing.com 021-64471599-8017

沪ICP备05003035号

沪公网安备 31010102002173号