Swagger 導出 PDF

原文出處:https://blog.csdn.net/qq_29534483/article/details/81235081

最下面附加了自己處理中文缺失的問題的解決辦法

加入依賴

Properties

<properties>
    <java.version>1.8</java.version>
    <swagger2markup.version>1.3.1</swagger2markup.version>
    <asciidoctor.input.directory>${project.build.directory}/src/docs/asciidoc/generated</asciidoctor.input.directory>
    <swagger.output.dir>${project.build.directory}/swagger</swagger.output.dir>
    <generated.asciidoc.directory>${project.build.directory}/src/docs/asciidoc/generated</generated.asciidoc.directory>
    <swagger.input>http://localhost:8080/v2/api-docs</swagger.input>
    <jackson.version>2.9.6</jackson.version>
 </properties>
repository

<repositories>
     <repository>
         <id>jcentral</id>
         <name>bintray</name>
         <url>http://jcenter.bintray.com</url>
         <snapshots>
             <enabled>false</enabled>
         </snapshots>
     </repository>
     <repository>
         <id>jcenter-snapshots</id>
         <name>jcenter</name>
         <url>http://oss.jfrog.org/artifactory/oss-snapshot-local/</url>
     </repository>
</repositories>
<pluginRepositories>
     <pluginRepository>
         <id>jcenter-snapshots</id>
         <name>jcenter</name>
         <url>http://oss.jfrog.org/artifactory/oss-snapshot-local/</url>
     </pluginRepository>
     <pluginRepository>
         <snapshots>
             <enabled>false</enabled>
         </snapshots>
         <id>jcenter-releases</id>
         <name>jcenter</name>
         <url>http://jcenter.bintray.com</url>
     </pluginRepository>
</pluginRepositories>
dependency
<dependency>
    <groupId>io.github.swagger2markup</groupId>
    <artifactId>swagger2markup</artifactId>
    <version>${swagger2markup.version}</version>
</dependency>
① plugin swagger2markup
<plugin>
    <groupId>io.github.swagger2markup</groupId>
    <artifactId>swagger2markup-maven-plugin</artifactId>
    <version>${swagger2markup.version}</version>
    <!--<dependencies>
        <dependency>
            <groupId>io.github.swagger2markup</groupId>
            <artifactId>swagger2markup-import-files-ext</artifactId>
            <version>${swagger2markup.version}</version>
        </dependency>
        <dependency>
            <groupId>io.github.swagger2markup</groupId>
            <artifactId>swagger2markup-spring-restdocs-ext</artifactId>
            <version>${swagger2markup.version}</version>
        </dependency>
    </dependencies>-->
    <configuration>
        <swaggerInput>${swagger.input}</swaggerInput>
        <outputDir>${generated.asciidoc.directory}</outputDir>
        <config>
            <swagger2markup.markupLanguage>ASCIIDOC</swagger2markup.markupLanguage>
            <swagger2markup.pathsGroupedBy>TAGS</swagger2markup.pathsGroupedBy>
        </config>
    </configuration>
    <executions>
        <execution>
            <phase>test</phase>
            <goals>
                 <goal>convertSwagger2markup</goal>
            </goals>
        </execution>
    </executions>
</plugin>
② plugin asciidoctor
<plugin>
    <groupId>org.asciidoctor</groupId>
    <artifactId>asciidoctor-maven-plugin</artifactId>
    <version>1.5.6</version>
    <!-- Include Asciidoctor PDF for pdf generation -->
    <dependencies>
        <dependency>
            <groupId>org.asciidoctor</groupId>
            <artifactId>asciidoctorj-pdf</artifactId>
            <version>1.5.0-alpha.16</version>
        </dependency>
        <dependency>
            <groupId>org.jruby</groupId>
            <artifactId>jruby-complete</artifactId>
            <version>1.7.24</version>
        </dependency>
    </dependencies>
    <!-- Configure generic document generation settings -->
    <configuration>
        <sourceDirectory>${asciidoctor.input.directory}</sourceDirectory>
        <!--<sourceDocumentName>overview.adoc</sourceDocumentName>-->
        <!--<sourceDocumentName>definitions.adoc</sourceDocumentName>-->
        <sourceDocumentName>paths.adoc</sourceDocumentName>
        <!--<sourceDocumentName>security.adoc</sourceDocumentName>-->
        <headerFooter>true</headerFooter>
        <doctype>book</doctype>
        <backend>pdf</backend>
        <sourceHighlighter>coderay</sourceHighlighter>
        <attributes>
            <toc>left</toc>
            <toclevels>3</toclevels>
            <sectnums>true</sectnums>
            <generated>${generated.asciidoc.directory}</generated>
        </attributes>
    </configuration>
</plugin>

操作步驟:

A Properties中的 <swagger.input> 記得改一下port 和 context-path

然后再啟動項目

B 執(zhí)行插件一(或使用指令 mvn swagger2markuo:convertSwagger2markup

文件會生成在插件一配置中 <outputDir> 的設定的路徑下(須新建該路徑)

會生成四個 .adoc文件允粤,分別是

definitions.adoc

overview.adoc

paths.adoc

security.adoc

C 插件二中的配置艰赞,<sourceDocumentName> 代表要轉(zhuǎn)換的文件(如果設置多個標簽,也只會執(zhí)行最后一個標簽)黍翎;<backend> 代表將要轉(zhuǎn)換的文件類型,可使用 pdf 或 html

插件二的執(zhí)行可以使用命令 mvn asciidoctor:process-asciidoc

問題記錄

插件二中甩鳄,默認使用的 asciidoctorj-pdf 依賴對中文的支持不太友好涣达,會出現(xiàn)部分文字變成空格的情況

根據(jù)博客https://blog.csdn.net/qq_29534483/article/details/81235081的描述规揪,記錄一下自己的做法

找到我使用的對應的jar包,

C:\Users\NagaSiren.m2\repository\org\asciidoctor\asciidoctorj-pdf\1.5.0-alpha.16\asciidoctorj-pdf-1.5.0-alpha.16.jar

1温峭、解壓該jar包猛铅,進入路徑gems\asciidoctor-pdf-1.5.0.alpha.16\data\fonts

添加一些自己的中文格式的ttf文件,本人是在 C://Windows/font里面找的一個系統(tǒng)的 simkai.ttf文檔

2凤藏、更改gems\asciidoctor-pdf-1.5.0.alpha.16\data\themes中的文件default-theme.yml

更改以下屬性即可奸忽,將原來的默認字體依賴改為我們新增的ttf(不要更改縮進)

 Noto Serif:
     normal: simkai.ttf
     bold: simkai.ttf
     italic: simkai.ttf
     bold_italic: simkai.ttf

最后替換掉jar中的這個yml配置文件,字體就正常了揖庄。


示例圖片
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末栗菜,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子抠艾,更是在濱河造成了極大的恐慌苛萎,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,640評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件检号,死亡現(xiàn)場離奇詭異,居然都是意外死亡蛙酪,警方通過查閱死者的電腦和手機齐苛,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,254評論 3 395
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來桂塞,“玉大人凹蜂,你說我怎么就攤上這事。” “怎么了玛痊?”我有些...
    開封第一講書人閱讀 165,011評論 0 355
  • 文/不壞的土叔 我叫張陵汰瘫,是天一觀的道長。 經(jīng)常有香客問我擂煞,道長混弥,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,755評論 1 294
  • 正文 為了忘掉前任对省,我火速辦了婚禮蝗拿,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘蒿涎。我一直安慰自己哀托,他們只是感情好,可當我...
    茶點故事閱讀 67,774評論 6 392
  • 文/花漫 我一把揭開白布劳秋。 她就那樣靜靜地躺著仓手,像睡著了一般。 火紅的嫁衣襯著肌膚如雪玻淑。 梳的紋絲不亂的頭發(fā)上嗽冒,一...
    開封第一講書人閱讀 51,610評論 1 305
  • 那天,我揣著相機與錄音岁忘,去河邊找鬼辛慰。 笑死,一個胖子當著我的面吹牛干像,可吹牛的內(nèi)容都是我干的帅腌。 我是一名探鬼主播,決...
    沈念sama閱讀 40,352評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼麻汰,長吁一口氣:“原來是場噩夢啊……” “哼速客!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起五鲫,我...
    開封第一講書人閱讀 39,257評論 0 276
  • 序言:老撾萬榮一對情侶失蹤溺职,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后位喂,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體浪耘,經(jīng)...
    沈念sama閱讀 45,717評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,894評論 3 336
  • 正文 我和宋清朗相戀三年塑崖,在試婚紗的時候發(fā)現(xiàn)自己被綠了七冲。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,021評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡规婆,死狀恐怖澜躺,靈堂內(nèi)的尸體忽然破棺而出蝉稳,到底是詐尸還是另有隱情,我是刑警寧澤掘鄙,帶...
    沈念sama閱讀 35,735評論 5 346
  • 正文 年R本政府宣布耘戚,位于F島的核電站,受9級特大地震影響操漠,放射性物質(zhì)發(fā)生泄漏收津。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,354評論 3 330
  • 文/蒙蒙 一颅夺、第九天 我趴在偏房一處隱蔽的房頂上張望朋截。 院中可真熱鬧,春花似錦吧黄、人聲如沸部服。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,936評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽廓八。三九已至,卻和暖如春赵抢,著一層夾襖步出監(jiān)牢的瞬間剧蹂,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,054評論 1 270
  • 我被黑心中介騙來泰國打工烦却, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留宠叼,地道東北人。 一個月前我還...
    沈念sama閱讀 48,224評論 3 371
  • 正文 我出身青樓其爵,卻偏偏與公主長得像冒冬,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子摩渺,可洞房花燭夜當晚...
    茶點故事閱讀 44,974評論 2 355

推薦閱讀更多精彩內(nèi)容

  • 更多精彩博文简烤,歡迎訪問我的個人博客 說明 我個人是一直使用Swagger作為接口文檔的說明的。但是由于在一些情況下...
    鵬徙南暝閱讀 1,180評論 0 1
  • Maven編譯代碼的相關(guān)命令 第一摇幻、main目錄下的主代碼編寫完畢后横侦,使用Maven進行編譯,在項目根目錄下運行命...
    加油小杜閱讀 1,190評論 0 2
  • maven常用命令介紹 這里主要是在eclipse中使用maven绰姻,因此只使用到了一部分命令枉侧,整理下來方便以后查閱...
    菜凱閱讀 1,099評論 0 2
  • 24.maven自動化部署 (待測試)# 在項目開發(fā)中,通常是部署過程包含以下步驟 檢入代碼在建項目全部進入SVN...
    明_27bf閱讀 560評論 0 0
  • SpringMVC原理分析 Spring Boot學習 5狂芋、Hello World探究 1棵逊、POM文件 1、父項目...
    jack_jerry閱讀 1,296評論 0 1