今天在開發(fā)完一個(gè)項(xiàng)目的接口之后,公司領(lǐng)導(dǎo)過來說:”需要一份word格式的接口文檔,***本門主任需要看這些文檔,記得接口文檔做的好看一點(diǎn)“。然后領(lǐng)導(dǎo)拍拍我的肩膀轉(zhuǎn)身就走了,身為一個(gè)資深后端,尤其是在外包公司,特別是給政府本門做外包的時(shí)候 。對于文檔要求特別多,什么都需要文檔說明。
我本人本身都不愛弄word這一塊的接口文檔,因?yàn)檫€要弄格式,每個(gè)接口參數(shù)、請求方式、響應(yīng)都需要自己去一個(gè)一個(gè)粘貼,調(diào)格式特別麻煩。有時(shí)候一個(gè)項(xiàng)目功能負(fù)責(zé)點(diǎn),接口特別多的時(shí)候。幾百個(gè)接口需要弄兩三天,比敲代碼還累就很苦惱。就在想有沒有工具弄夠在我開發(fā)接口的時(shí)候,既能測試接口是否通順,還能生成網(wǎng)頁格式的接口文檔或者我開發(fā)的時(shí)候前端也能在這個(gè)軟件中看到我開發(fā)的接口,然后他通過這個(gè)工具測試接口是否開發(fā)完成。查看接口返回的數(shù)值。最重要是還能支持word格式的接口文檔。
我先使用了postman,能支持生成接口文檔,還能測試接口,但是英文版的看的比較費(fèi)勁。還有就是不能生成樣板格式完美的word版本的接口文檔。
就在想國內(nèi)有沒有一款這樣的軟件,于是就在網(wǎng)上查找起來,發(fā)現(xiàn)有幾個(gè)做接口測試的工具但是還是沒有我需要的,要么就是和postman一樣的,要么就是操作使用特別復(fù)雜的東西,體驗(yàn)感極差。
然后把需求發(fā)給自己經(jīng)常活躍的技術(shù)活動(dòng)交流群,有人告訴我有一個(gè)叫apipost的接口文檔生成工具,可以生成word格式的接口測試文檔。然后我就去下載試用了一下。
這個(gè)軟件使用的時(shí)候需要注冊有點(diǎn)煩,但是對于要寫幾百個(gè)接口文檔的煩惱這個(gè)啥都不算了。
注冊之后,需要生成一個(gè)項(xiàng)目才可以繼續(xù)下去,我把我的項(xiàng)目編寫了一下,然后開始了接口測試
全中文版的還不錯(cuò),測試接口也很不錯(cuò),然后去試試怎么生成接口文檔的功能。
看了一下有一個(gè)分享的功能點(diǎn)進(jìn)去操作一下
去復(fù)制鏈接,然后去網(wǎng)頁中打開。
看著網(wǎng)頁版的接口文檔,感覺挺不錯(cuò)的,但是我想要的是word格式的接口文檔啊!仔細(xì)觀看了一下,有一個(gè)導(dǎo)出離線文檔,打開一看。我需要的導(dǎo)出word格式在這啊。果斷點(diǎn)擊下載??纯葱Ч?,如圖:
導(dǎo)出的word樣式排版格式感覺就特別棒。不過這是單個(gè)接口的,去試試多個(gè)接口的,整個(gè)項(xiàng)目的接口生成word格式的接口文檔。
我們還是需要分享項(xiàng)目,然后在網(wǎng)頁上才能進(jìn)行word格式的下載。
打開壓縮包,發(fā)現(xiàn)生成的是單個(gè)文件,還需要自己合并
合并教程office和wpc都是一樣的合并方式:
在插入中找到對象,選擇對象中的文件中的文字,進(jìn)行文件合并。
這就是apipost如何生成word格式的接口文檔了。剩下的我們很大一筆寫word格式的接口文檔時(shí)間。