將Swagger2文檔導(dǎo)出為HTML或markdown等格式離線閱讀

網(wǎng)上有很多《使用swagger2構(gòu)建API文檔》的文章，swagger2文檔是一個(gè)在線文檔，需要使用HTTP訪問。但是在我們?nèi)粘Ｊ褂胹wagger接口文檔的時(shí)候，有的時(shí)候需要接口文檔離線訪問，如將文檔導(dǎo)出為html、markdown格式。又或者我們不希望應(yīng)用系統(tǒng)與swagger接口文檔使用同一個(gè)服務(wù)，而是導(dǎo)出HTML之后單獨(dú)部署，這樣做保證了對(duì)接口文檔的訪問不影響業(yè)務(wù)系統(tǒng)，也一定程度提高了接口文檔的安全性。核心的實(shí)現(xiàn)過程就是：

在swagger2接口文檔所在的應(yīng)用內(nèi)，利用swagger2markup將接口文檔導(dǎo)出為adoc文件，也可以導(dǎo)出markdown文件。
然后將adoc文件轉(zhuǎn)換為靜態(tài)的html格式，可以將html發(fā)布到nginx或者其他的web應(yīng)用容器，提供訪問（本文不會(huì)講html靜態(tài)部署，只講HTML導(dǎo)出)。

注意：adoc是一種文件格式，不是我的筆誤。不是doc文件也不是docx文件。

一、maven依賴類庫(kù)

在已經(jīng)集成了swagger2的應(yīng)用內(nèi)，通過maven坐標(biāo)引入相關(guān)依賴類庫(kù),pom.xml代碼如下：

swagger2markup用于將swagger2在線接口文檔導(dǎo)出為html,markdown,adoc等格式文檔，用于靜態(tài)部署或離線閱讀。其中第一個(gè)maven坐標(biāo)是必須的。后兩個(gè)maven坐標(biāo)，當(dāng)你在執(zhí)行后面的代碼過程中報(bào)下圖中的ERROR，或者有的類無法import的時(shí)候使用。

swagger2markup過程可能拋出的異常

產(chǎn)生異常的原因已經(jīng)有人在github的issues上給出解釋了：當(dāng)你使用swagger-core版本大于等于1.5.11,并且swagger-models版本小于1.5.11就會(huì)有異常發(fā)生。所以我們顯式的引入這兩個(gè)jar，替換掉swagger2默認(rèn)引入的這兩個(gè)jar。

swagger2markup異常的解決方案

二、生成adoc格式文件

下面的代碼是通過編碼方式實(shí)現(xiàn)的生成adoc格式文件的方式

使用RunWith注解和SpringBootTest注解，啟動(dòng)應(yīng)用服務(wù)容器。 SpringBootTest.WebEnvironment.DEFINED_PORT表示使用application.yml定義的端口，而不是隨機(jī)使用一個(gè)端口進(jìn)行測(cè)試，這很重要。
Swagger2MarkupConfig 是輸出文件的配置，如文件的格式和文件中的自然語(yǔ)言等
Swagger2MarkupConverter的from表示哪一個(gè)HTTP服務(wù)作為資源導(dǎo)出的源頭(JSON格式)，可以自己訪問試一下這個(gè)鏈接。8888是我的服務(wù)端口，需要根據(jù)你自己的應(yīng)用配置修改。
toFile表示將導(dǎo)出文件存放的位置，不用加后綴名。也可以使用toFolder表示文件導(dǎo)出存放的路徑。二者區(qū)別在于使用toFolder導(dǎo)出為文件目錄下按標(biāo)簽TAGS分類的多個(gè)文件，使用toFile是導(dǎo)出一個(gè)文件（toFolder多個(gè)文件的合集）。