使用apipost工具快速生成在線(xiàn)接口文檔

ApiPost是一個(gè)支持團(tuán)隊(duì)協(xié)作，并可直接生成文檔的API調(diào)試、管理工具。它支持模擬POST、GET、PUT等常見(jiàn)請(qǐng)求，是后臺(tái)接口開(kāi)發(fā)者或前端、接口測(cè)試人員不可多得的工具 。使用者不僅可以利用apiopst調(diào)試接口，還可以書(shū)寫(xiě)相關(guān)注釋?zhuān)ń涌谖臋n），方便的生成可讀性好、界面美觀的在線(xiàn)接口文檔。

本文主要包含以下內(nèi)容：

介紹ApiPost工具，它能做什么

下載、安裝的方法

一些常用的操作

介紹一些使用技巧

前言：apipost能做什么？

ApiPost是一個(gè)支持團(tuán)隊(duì)協(xié)作，并可直接生成文檔的API調(diào)試、管理工具。它可以像postman那樣支持模擬POST、GET、PUT等常見(jiàn)請(qǐng)求也可以快速生成接口文檔，是后臺(tái)接口開(kāi)發(fā)者或前端、接口測(cè)試人員不可多得的工具 。首先看下它的界面風(fēng)格。

下載、安裝apipost

ApiPost安裝下載十分簡(jiǎn)單，在官網(wǎng)（自行百度）直接下載對(duì)應(yīng)操作系統(tǒng)的安裝包（支持window、mac、linux）安裝即可，官網(wǎng)也提供了豐富的安裝文檔，這里不再贅述了。

一些常用的操作

ApiPost支持常見(jiàn)的接口發(fā)送、文檔生成等。作為一名開(kāi)發(fā)者，相信你從上面截圖就可以基本看出來(lái)它的使用方法。這里主要介紹一些其他的常見(jiàn)操作。不過(guò)初次使用的時(shí)候，需要先注冊(cè)一個(gè)賬號(hào)，創(chuàng)建一個(gè)項(xiàng)目，然后點(diǎn)擊左側(cè)的 APIS 菜單欄就進(jìn)到控制臺(tái)了。

以下圖是針對(duì)目錄的常用操作

總之使用基本很簡(jiǎn)單，你下載安裝一看就會(huì)了，實(shí)在有問(wèn)題可以去官網(wǎng)查看文檔或者去社區(qū)提問(wèn)。

一些操作技巧

小技巧之：快速導(dǎo)入?yún)?shù)

apipost支持多種格式的參數(shù)導(dǎo)入，見(jiàn)下圖，你再也不用一個(gè)一個(gè)參數(shù)的慢慢寫(xiě)了：

導(dǎo)入格式支持key-value和json格式：

1-1：key-value格式導(dǎo)入示例：

key-value格式常見(jiàn)的就是瀏覽器（F12）控制臺(tái)的數(shù)據(jù)格式，見(jiàn)下圖：

我們，復(fù)制以上請(qǐng)求頭參數(shù)，然后粘貼到apipost，點(diǎn)擊導(dǎo)入

參數(shù)則瞬間導(dǎo)入到了請(qǐng)求參數(shù)中，見(jiàn)下圖：

以上示例只是展示了如何快速導(dǎo)入到header參數(shù)，其他參數(shù)比如query、body操作方式是一模一樣滴。

1-2：json格式導(dǎo)入示例：

apipost也支持json格式的參數(shù)導(dǎo)入，參數(shù)格式可以如下：

{ ????"id":?123, ????"title":?"我是標(biāo)題" }

如圖，點(diǎn)擊導(dǎo)入，參數(shù)也快速導(dǎo)入到了請(qǐng)求參數(shù)中。

小技巧之：參數(shù)注釋自動(dòng)識(shí)別

上面我們寫(xiě)了如何快速導(dǎo)入?yún)?shù)，其實(shí)對(duì)于生成接口文檔來(lái)說(shuō)，參數(shù)描述（注釋?zhuān)┎攀亲钜模瑢?duì)于我們一直忙碌的程序員，花大量時(shí)間用在寫(xiě)文檔上實(shí)在太累！

好在apipost幫我們節(jié)省了很多時(shí)間，一個(gè)參數(shù)，只要寫(xiě)過(guò)一次注釋?zhuān)麓斡龅酵瑯拥膮?shù)直接選中就行。舉例：

在上圖中，我們針對(duì)id和title寫(xiě)了對(duì)應(yīng)的注釋?zhuān)?/p>

id：“我是文章Id”

title：“我是文章標(biāo)題”

當(dāng)我們新建一個(gè)接口的時(shí)候，假如這個(gè)接口同樣用到了?id或者title等參數(shù)，點(diǎn)擊參數(shù)描述就會(huì)呈現(xiàn)出剛剛輸入過(guò)的參數(shù)描述，直接選中即可，不用再麻煩的打字輸入了。

這個(gè)小功能是不是節(jié)約了開(kāi)發(fā)小伙伴很多時(shí)間呢？

小技巧之：快速定位當(dāng)前接口目錄

左側(cè)的目錄默認(rèn)都是閉合的，有時(shí)候我們不知道當(dāng)前正在編輯的接口屬于哪個(gè)目錄，找起來(lái)相當(dāng)頭疼。apipost提供了“定位到當(dāng)前接口目錄” 功能（見(jiàn)下圖），可以快速打開(kāi)當(dāng)前正在編輯的接口、文檔所在的目錄，是不是解決了您的大問(wèn)題了呢？

其實(shí)，apipost還有很多很多更加符合中國(guó)人操作習(xí)慣的小功能，等待您去發(fā)現(xiàn)。

小技巧之：生成并分享在線(xiàn)接口文檔

說(shuō)了這么多，好像還沒(méi)說(shuō)到重點(diǎn)，apipost怎么生成接口文檔呢？很簡(jiǎn)單：新版ApiPost支持分享單個(gè)項(xiàng)目、也支持分享單個(gè)目錄或者文檔：

支持設(shè)置文檔鏈接的有效期：

支持設(shè)置文檔的查看權(quán)限：

小TIPS：apipost 導(dǎo)出文檔響應(yīng)為空？

很多小伙伴問(wèn)，為什么apipost 導(dǎo)出文檔響應(yīng)為空？那是因?yàn)槟忝从刑砑禹憫?yīng)示例。

ApiPost生成的文檔怎么添加響應(yīng)示例？很簡(jiǎn)單：

小技巧之：快速克隆一個(gè)項(xiàng)目

有時(shí)候我們需要復(fù)制一個(gè)項(xiàng)目的數(shù)據(jù)，ApiPost如何克隆（復(fù)制）一個(gè)項(xiàng)目？

很簡(jiǎn)單：

小技巧之：resful風(fēng)格的接口的路徑變量

類(lèi)似這樣風(fēng)格的接口：

ApiPost支持把像這樣的restful風(fēng)格鏈接中的uid也就是1作為參數(shù)單獨(dú)提出來(lái)比較方便調(diào)試和解釋。

只需要把URL路徑中的ID設(shè)置為

即可。

這樣的話(huà)，我們生成的文檔就會(huì)類(lèi)似：

API 單元測(cè)試

版權(quán)聲明：本文內(nèi)容由網(wǎng)絡(luò)用戶(hù)投稿，版權(quán)歸原作者所有，本站不擁有其著作權(quán)，亦不承擔(dān)相應(yīng)法律責(zé)任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實(shí)的內(nèi)容，請(qǐng)聯(lián)系我們jiasou666@gmail.com 處理，核實(shí)后本網(wǎng)站將在24小時(shí)內(nèi)刪除侵權(quán)內(nèi)容。

版權(quán)聲明：本文內(nèi)容由網(wǎng)絡(luò)用戶(hù)投稿，版權(quán)歸原作者所有，本站不擁有其著作權(quán)，亦不承擔(dān)相應(yīng)法律責(zé)任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實(shí)的內(nèi)容，請(qǐng)聯(lián)系我們jiasou666@gmail.com 處理，核實(shí)后本網(wǎng)站將在24小時(shí)內(nèi)刪除侵權(quán)內(nèi)容。