天天看點

使用apipost調試api接口并快速生成接口文檔的一些小技巧,比postman更好用

apipost是一款兼顧api接口調試(postman的主要功能)和接口文檔生成(淘寶rap的主要功能)的工具,而且在2者的基礎上,增加了很多更加人性的操作

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/

使用apipost調試api接口并快速生成接口文檔的一些小技巧,比postman更好用