對(duì)于一個(gè)后端人員,給可愛(ài)的前端妹子或者帥氣的app開(kāi)發(fā)小哥哥生成接口文檔是一件必不可少而又十分頭疼的事情。通常情況下,我們會(huì)用postman調(diào)試接口,然后用rap、甚至word等工具再編寫接口文檔,重復(fù)工作,十分難受。
apipost的出現(xiàn),解決了所有后端開(kāi)發(fā)人員的痛點(diǎn)。
apipost的定位是:一款提升開(kāi)發(fā)、測(cè)試團(tuán)隊(duì)效率,可直接生成文檔的API調(diào)試、管理工具。
它的便捷之處,便在于它不僅完美支持類似postman的接口調(diào)試功能,而且更重要的是,它支持快速、優(yōu)雅的生成漂亮的文檔。
以下界面,就是apipost接口調(diào)試控制臺(tái)的全貌。
是不是很熟悉?事實(shí)上,除了類似postman那些您熟悉的配方和味道的接口調(diào)試功能,它也加入了更多適合中國(guó)人習(xí)慣的小功能。比如:
亮點(diǎn)小功能之:快速導(dǎo)入?yún)?shù)
apipost支持多種格式的參數(shù)導(dǎo)入,見(jiàn)下圖,你再也不用一個(gè)一個(gè)參數(shù)的慢慢寫了:
導(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ù)中。
亮點(diǎn)小功能之:參數(shù)注釋自動(dòng)識(shí)別
上面我們寫了如何快速導(dǎo)入?yún)?shù),其實(shí)對(duì)于生成接口文檔來(lái)說(shuō),參數(shù)描述(注釋)才是最要命的,對(duì)于我們一直忙碌的程序員,花大量時(shí)間用在寫文檔上實(shí)在太累!
好在apipost幫我們節(jié)省了很多時(shí)間,一個(gè)參數(shù),只要寫過(guò)一次注釋,下次遇到同樣的參數(shù)直接選中就行。舉例:
在上圖中,我們針對(duì)id和title寫了對(duì)應(yīng)的注釋:
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í)間呢?
亮點(diǎn)小功能之:快速定位當(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)。
說(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)單:
官網(wǎng):https://docs.apipost.cn/