使用apipost调试api接口并快速生成接口文档的一些小技巧,比postman更好用

ApiPost团队 工具 2020-05-19

apipost是一款兼顾api接口调试(postman的主要功能)和接口文档生成(淘宝rap的主要功能)的工具,而且在2者的基础上,增加了很多更加人性的操作,不用不知道,一用就甩不掉了。

技巧一:快速导入参数

apipost支持多种格式的参数导入,见下图,你再也不用一个一个参数的慢慢写了:

使用apipost调试api接口并快速生成接口文档的一些小技巧,比postman更好用

导入格式支持key-value和json格式:

使用apipost调试api接口并快速生成接口文档的一些小技巧,比postman更好用

1-1:key-value格式导入示例:

key-value格式常见的就是浏览器(F12)控制台的数据格式,见下图:

使用apipost调试api接口并快速生成接口文档的一些小技巧,比postman更好用

我们,复制以上请求头参数,然后粘贴到apipost,点击导入

使用apipost调试api接口并快速生成接口文档的一些小技巧,比postman更好用

参数则瞬间导入到了请求参数中,见下图:

使用apipost调试api接口并快速生成接口文档的一些小技巧,比postman更好用

以上示例只是展示了如何快速导入到header参数,其他参数比如query、body操作方式是一模一样滴。

1-2:json格式导入示例:

apipost也支持json格式的参数导入,参数格式可以如下:

{
	"id": 123,
	"title": "我是标题"
}

使用apipost调试api接口并快速生成接口文档的一些小技巧,比postman更好用

如图,点击导入,参数也快速导入到了请求参数中。

使用apipost调试api接口并快速生成接口文档的一些小技巧,比postman更好用

技巧二:参数注释自动识别

上面我们写了如何快速导入参数,其实对于生成接口文档来说,参数描述(注释)才是最要命的,对于我们一直忙碌的程序员,花大量时间用在写文档上实在太累!

好在apipost帮我们节省了很多时间,一个参数,只要写过一次注释,下次遇到同样的参数直接选中就行。举例:

使用apipost调试api接口并快速生成接口文档的一些小技巧,比postman更好用

在上图中,我们针对id和title写了对应的注释:

id:“我是文章Id

title:“我是文章标题

当我们新建一个接口的时候,假如这个接口同样用到了 id或者title等参数,点击参数描述就会呈现出刚刚输入过的参数描述,直接选中即可,不用再麻烦的打字输入了。使用apipost调试api接口并快速生成接口文档的一些小技巧,比postman更好用

这个小功能是不是节约了开发小伙伴很多时间呢?

技巧三:快速定位当前接口目录

左侧的目录默认都是闭合的,有时候我们不知道当前正在编辑的接口属于哪个目录,找起来相当头疼。apipost提供了“定位到当前接口目录” 功能(见下图),可以快速打开当前正在编辑的接口、文档所在的目录,是不是解决了您的大问题了呢?

使用apipost调试api接口并快速生成接口文档的一些小技巧,比postman更好用

apipost还有很多很多更加符合中国人操作习惯的小功能,等待您去发现。

强烈建议您安装使用,官网:https://www.apipost.cn/

中文版Postman,rap文档管理

评论