swagger導(dǎo)出 接口文檔

在pom.xml中添加以下配置:

<plugin>
                <groupId>io.github.swagger2markup</groupId>
                <artifactId>swagger2markup-maven-plugin</artifactId>
                <version>1.3.3</version>
                <configuration>
                    <!--swagger頁面可以看到-->
                    <swaggerInput>項目訪問根路徑/v2/api-docs</swaggerInput>
                    <!--生成多個文件-->
                    <!--<outputDir>./docs/asciidoc/generated/all</outputDir>-->
                    <!--生成單個文件-->
                    <outputFile>./docs/asciidoc/generated/xxx-api</outputFile>
                    <config>
                        <!-- 除了ASCIIDOC之外,還有MARKDOWN和CONFLUENCE_MARKUP可選 -->
                        <swagger2markup.markupLanguage>ASCIIDOC</swagger2markup.markupLanguage>
                    </config>
                </configuration>
                <executions>
                    <execution>
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>convertSwagger2markup</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.asciidoctor</groupId>
                <artifactId>asciidoctor-maven-plugin</artifactId>
                <version>1.5.6</version>
                <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>9.2.8.0</version>
                    </dependency>
                </dependencies>
                <configuration>
                    <!--asciidoc文件所在路徑-->
                    <sourceDirectory>./docs/asciidoc/generated</sourceDirectory>
                    <headerFooter>true</headerFooter>
                    <doctype>book</doctype>
                    <sourceHighlighter>coderay</sourceHighlighter>
                    <attributes>
                        <!--菜單欄在左邊-->
                        <toc>left</toc>
                        <!--多標(biāo)題排列-->
                        <toclevels>3</toclevels>
                        <!--自動打數(shù)字序號-->
                        <sectnums>true</sectnums>
                    </attributes>
                </configuration>
                <executions>
                    <execution>
                        <id>output-html</id>
                        <phase>generate-resources</phase>
                        <goals>
                            <goal>process-asciidoc</goal>
                        </goals>
                        <configuration>
                            <backend>html5</backend>
                            <outputDirectory>./docs/asciidoc/html</outputDirectory>
                        </configuration>
                    </execution>
                    <execution>
                        <id>output-pdf</id>
                        <phase>generate-resources</phase>
                        <goals>
                            <goal>process-asciidoc</goal>
                        </goals>
                        <configuration>
                            <backend>pdf</backend>
                            <outputDirectory>./docs/asciidoc/pdf</outputDirectory>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

執(zhí)行 maven compile即可漫雷。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市卸勺,隨后出現(xiàn)的幾起案子银择,更是在濱河造成了極大的恐慌,老刑警劉巖妙蔗,帶你破解...
    沈念sama閱讀 211,743評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件蚕冬,死亡現(xiàn)場離奇詭異免猾,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)囤热,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,296評論 3 385
  • 文/潘曉璐 我一進(jìn)店門猎提,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人旁蔼,你說我怎么就攤上這事锨苏。” “怎么了棺聊?”我有些...
    開封第一講書人閱讀 157,285評論 0 348
  • 文/不壞的土叔 我叫張陵伞租,是天一觀的道長。 經(jīng)常有香客問我躺屁,道長肯夏,這世上最難降的妖魔是什么经宏? 我笑而不...
    開封第一講書人閱讀 56,485評論 1 283
  • 正文 為了忘掉前任犀暑,我火速辦了婚禮,結(jié)果婚禮上烁兰,老公的妹妹穿的比我還像新娘耐亏。我一直安慰自己,他們只是感情好沪斟,可當(dāng)我...
    茶點故事閱讀 65,581評論 6 386
  • 文/花漫 我一把揭開白布广辰。 她就那樣靜靜地躺著,像睡著了一般主之。 火紅的嫁衣襯著肌膚如雪择吊。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,821評論 1 290
  • 那天槽奕,我揣著相機(jī)與錄音几睛,去河邊找鬼。 笑死粤攒,一個胖子當(dāng)著我的面吹牛所森,可吹牛的內(nèi)容都是我干的囱持。 我是一名探鬼主播,決...
    沈念sama閱讀 38,960評論 3 408
  • 文/蒼蘭香墨 我猛地睜開眼焕济,長吁一口氣:“原來是場噩夢啊……” “哼纷妆!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起晴弃,我...
    開封第一講書人閱讀 37,719評論 0 266
  • 序言:老撾萬榮一對情侶失蹤掩幢,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后肝匆,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體粒蜈,經(jīng)...
    沈念sama閱讀 44,186評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,516評論 2 327
  • 正文 我和宋清朗相戀三年旗国,在試婚紗的時候發(fā)現(xiàn)自己被綠了枯怖。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,650評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡能曾,死狀恐怖度硝,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情寿冕,我是刑警寧澤蕊程,帶...
    沈念sama閱讀 34,329評論 4 330
  • 正文 年R本政府宣布,位于F島的核電站驼唱,受9級特大地震影響藻茂,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜玫恳,卻給世界環(huán)境...
    茶點故事閱讀 39,936評論 3 313
  • 文/蒙蒙 一辨赐、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧京办,春花似錦掀序、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,757評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至财饥,卻和暖如春换吧,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背钥星。 一陣腳步聲響...
    開封第一講書人閱讀 31,991評論 1 266
  • 我被黑心中介騙來泰國打工沾瓦, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 46,370評論 2 360
  • 正文 我出身青樓暴拄,卻偏偏與公主長得像漓滔,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子乖篷,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 43,527評論 2 349