作為后端開(kāi)發(fā)者,如何更優(yōu)雅、便捷的生成接口文檔?

對(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/

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,572評(píng)論 6 531
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,071評(píng)論 3 414
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人,你說(shuō)我怎么就攤上這事。” “怎么了?”我有些...
    開(kāi)封第一講書人閱讀 175,409評(píng)論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我,道長(zhǎng),這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書人閱讀 62,569評(píng)論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 71,360評(píng)論 6 404
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書人閱讀 54,895評(píng)論 1 321
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,979評(píng)論 3 440
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書人閱讀 42,123評(píng)論 0 286
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,643評(píng)論 1 333
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 40,559評(píng)論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 42,742評(píng)論 1 369
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,250評(píng)論 5 356
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 43,981評(píng)論 3 346
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 34,363評(píng)論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 35,622評(píng)論 1 280
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 51,354評(píng)論 3 390
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 47,707評(píng)論 2 370