美文网首页
2018-12-04swaggermarkup 生成静态文件

2018-12-04swaggermarkup 生成静态文件

作者: Suncoffee_psw | 来源:发表于2018-12-04 10:46 被阅读0次

    1、创建目录文件

    在项目中创建以下目录文件:
    src/docs/asciidoc/generated,如下图所示;


    image.png
    • 在asciidoc目录下创建index.adoc文件,文件内容为:
      include::{generated}/overview.adoc[]
      include::{generated}/paths.adoc[]
      include::{generated}/security.adoc[]
      include::{generated}/definitions.adoc[]

    2、修改pom文件,引入相关的依赖包:

    <dependency>
    <groupId>io.github.swagger2markup</groupId>
    <artifactId>swagger2markup</artifactId>
    <version>1.3.3</version>
    </dependency>
    <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>

    <plugin>
    <groupId>io.github.swagger2markup</groupId>
    <artifactId>swagger2markup-maven-plugin</artifactId>
    <version>1.3.3</version>
    <configuration>
    <swaggerInput>http://localhost:9004/v2/api-docs</swaggerInput>
    <outputDir>src/docs/asciidoc/generated</outputDir>
    <config>
    <swagger2markup.markupLanguage>ASCIIDOC</swagger2markup.markupLanguage>
    </config>
    </configuration>
    </plugin>
    <plugin>
    <groupId>org.asciidoctor</groupId>
    <artifactId>asciidoctor-maven-plugin</artifactId>
    <version>1.5.6</version>
    <configuration>

    <sourceDirectory>src/docs/asciidoc/generated</sourceDirectory>

    <outputDirectory>src/docs/asciidoc/html</outputDirectory>
    <backend>html</backend>
    <sourceHighlighter>coderay</sourceHighlighter>
    <attributes>

    <toc>left</toc>



    <sectnums>true</sectnums>
    </attributes>
    </configuration>
    </plugin>
    <repositories>
    <repository>
    <id>jcentral</id>
    <name>bintray</name>
    <url>http://jcenter.bintray.com</url>
    <snapshots>
    <enabled>false</enabled>
    </snapshots>
    </repository>
    </repositories>

    • 注意:swaggerInput 中的内容为实际项目的URL,如下图所示:


      image.png

    3、文件生成

    • 确认在maven插件中是否有以下两个插件,如图所示:


      image.png
    • 执行顺序:
      先启动相应的服务。
      执行:swagger2markup-maven-plugin,执行完成后会在生成以下文件:


      image.png

      执行:process-asiidoc,生成相应的html文件:


      image.png

    4、HTML转为PDF

    目前不进行插件转化为PDF,通过打印的页面的方式另存为pdf文件:
    
    image.png

    相关文章

      网友评论

          本文标题:2018-12-04swaggermarkup 生成静态文件

          本文链接:https://www.haomeiwen.com/subject/wvxmcqtx.html