使用ApiPost工具快速生成在線接口文檔


ApiPost是一個支持團隊協作,並可直接生成文檔的API調試、管理工具。它支持模擬POST、GET、PUT等常見請求,是后台接口開發者或前端、接口測試人員不可多得的工具 。使用者不僅可以利用apiopst調試接口,還可以書寫相關注釋(接口文檔),方便的生成可讀性好、界面美觀的在線接口文檔。

本文主要包含以下內容:

介紹ApiPost工具,它能做什么

下載、安裝的方法

一些常用的操作

介紹一些使用技巧

前言:apipost能做什么?

ApiPost是一個支持團隊協作,並可直接生成文檔的API調試、管理工具。它可以像postman那樣支持模擬POST、GET、PUT等常見請求也可以快速生成接口文檔,是后台接口開發者或前端、接口測試人員不可多得的工具 。首先看下它的界面風格。

使用apipost工具快速生成在線接口文檔

下載、安裝apipost

ApiPost安裝下載十分簡單,在官網(自行百度)直接下載對應操作系統的安裝包(支持window、mac、linux)安裝即可,官網也提供了豐富的安裝文檔,這里不再贅述了。

一些常用的操作

ApiPost支持常見的接口發送、文檔生成等。作為一名開發者,相信你從上面截圖就可以基本看出來它的使用方法。這里主要介紹一些其他的常見操作。不過初次使用的時候,需要先注冊一個賬號,創建一個項目,然后點擊左側的 APIS 菜單欄就進到控制台了。

以下圖是針對目錄的常用操作

使用apipost工具快速生成在線接口文檔

總之使用基本很簡單,你下載安裝一看就會了,實在有問題可以去官網查看文檔或者去社區提問。

一些操作技巧

小技巧之:快速導入參數

apipost支持多種格式的參數導入,見下圖,你再也不用一個一個參數的慢慢寫了:

使用apipost工具快速生成在線接口文檔

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

使用apipost工具快速生成在線接口文檔

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

key-value格式常見的就是瀏覽器(F12)控制台的數據格式,見下圖:

使用apipost工具快速生成在線接口文檔

我們,復制以上請求頭參數,然后粘貼到apipost,點擊導入

使用apipost工具快速生成在線接口文檔

參數則瞬間導入到了請求參數中,見下圖:

使用apipost工具快速生成在線接口文檔

以上示例只是展示了如何快速導入到header參數,其他參數比如query、body操作方式是一模一樣滴。

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

apipost也支持json格式的參數導入,參數格式可以如下:

{
	"id": 123, "title": "我是標題" }

使用apipost工具快速生成在線接口文檔

如圖,點擊導入,參數也快速導入到了請求參數中。

使用apipost工具快速生成在線接口文檔

小技巧之:參數注釋自動識別

上面我們寫了如何快速導入參數,其實對於生成接口文檔來說,參數描述(注釋)才是最要命的,對於我們一直忙碌的程序員,花大量時間用在寫文檔上實在太累!

好在apipost幫我們節省了很多時間,一個參數,只要寫過一次注釋,下次遇到同樣的參數直接選中就行。舉例:

使用apipost工具快速生成在線接口文檔

在上圖中,我們針對id和title寫了對應的注釋:

id:“我是文章Id”

title:“我是文章標題”

當我們新建一個接口的時候,假如這個接口同樣用到了 id或者title等參數,點擊參數描述就會呈現出剛剛輸入過的參數描述,直接選中即可,不用再麻煩的打字輸入了。使用apipost工具快速生成在線接口文檔

這個小功能是不是節約了開發小伙伴很多時間呢?

小技巧之:快速定位當前接口目錄

左側的目錄默認都是閉合的,有時候我們不知道當前正在編輯的接口屬於哪個目錄,找起來相當頭疼。apipost提供了“定位到當前接口目錄” 功能(見下圖),可以快速打開當前正在編輯的接口、文檔所在的目錄,是不是解決了您的大問題了呢?

使用apipost工具快速生成在線接口文檔

其實,apipost還有很多很多更加符合中國人操作習慣的小功能,等待您去發現。

小技巧之:生成並分享在線接口文檔

說了這么多,好像還沒說到重點,apipost怎么生成接口文檔呢?很簡單:新版ApiPost支持分享單個項目、也支持分享單個目錄或者文檔:

使用apipost工具快速生成在線接口文檔

支持設置文檔鏈接的有效期:

使用apipost工具快速生成在線接口文檔

支持設置文檔的查看權限:

使用apipost工具快速生成在線接口文檔

小TIPS:apipost 導出文檔響應為空?

很多小伙伴問,為什么apipost 導出文檔響應為空?那是因為你么有添加響應示例。

ApiPost生成的文檔怎么添加響應示例?很簡單:

使用apipost工具快速生成在線接口文檔

小技巧之:快速克隆一個項目

有時候我們需要復制一個項目的數據,ApiPost如何克隆(復制)一個項目?

很簡單:

使用apipost工具快速生成在線接口文檔

小技巧之:resful風格的接口的路徑變量

類似這樣風格的接口:

http://example.com/api/users/1  //GET 獲取標識為1用戶信息

ApiPost支持把像這樣的restful風格鏈接中的uid也就是1作為參數單獨提出來比較方便調試和解釋。

只需要把URL路徑中的ID設置為 

:變量名 

即可。

使用apipost工具快速生成在線接口文檔

這樣的話,我們生成的文檔就會類似:

使用apipost工具快速生成在線接口文檔

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM