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

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

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

一、maven依賴類庫

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

io.github.

HTML Markdown

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