Swagger2 生成離線文檔HTML或PDF

      由於項目需要,這幾天一直在研究如何用swagger生成離線文檔,網上也有許多如何解決該問題的方案,很多解決方案都只針對某一個類進行生成文檔,這個工作量還不如手動去寫文檔,直到我看了如下的代碼....

主要參考如下代碼:

https://gitee.com/qixiaobo/swagger-offline-doc/tree/master

按照上述代碼引入相關包後,本地環境仍然會遇到如下問題:

1.啓動test命令後無法生成swagger.json文件。

2.生成的文檔內容不完整。

 

上述問題1的現象如下:

原因如圖所示,調過了test命令,後來發現在依賴包中用如下的引入:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>2.19.1</version>
    <configuration>
        <skipTests>true</skipTests>    <!--默認關掉單元測試 -->
    </configuration>
</plugin>

原本只是想改爲false就可以了,但是該依賴的引入已經在第三方包中存在,無法進行修改

解決辦法:在目前本地的pom文件中再加一個同樣的依賴覆蓋父類中的依賴

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>2.19.1</version>
    <configuration>
        <skipTests>false</skipTests>    <!--打開單元測試 -->
    </configuration>
</plugin>

 

問題2 的原因在於,原來下載下來的index.adoc文件中顯示如下:

中括號換行了,導致最後一個文件沒有被加載進來,將中括號改回同一行即可“[]”

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章