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

1、创建目录文件

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


2018-12-04swaggermarkup 生成静态文件_第1张图片
image.png
  • 在asciidoc目录下创建index.adoc文件,文件内容为:
    include::{generated}/overview.adoc[]
    include::{generated}/paths.adoc[]
    include::{generated}/security.adoc[]
    include::{generated}/definitions.adoc[]

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


io.github.swagger2markup
swagger2markup
1.3.3



jcenter-snapshots
jcenter
http://oss.jfrog.org/artifactory/oss-snapshot-local/



false

jcenter-releases
jcenter
http://jcenter.bintray.com


io.github.swagger2markup
swagger2markup-maven-plugin
1.3.3

http://localhost:9004/v2/api-docs
src/docs/asciidoc/generated

ASCIIDOC




org.asciidoctor
asciidoctor-maven-plugin
1.5.6


src/docs/asciidoc/generated

src/docs/asciidoc/html
html
coderay


left



true





jcentral
bintray
http://jcenter.bintray.com

false


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


    2018-12-04swaggermarkup 生成静态文件_第2张图片
    image.png

3、文件生成

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


    2018-12-04swaggermarkup 生成静态文件_第3张图片
    image.png
  • 执行顺序:
    先启动相应的服务。
    执行:swagger2markup-maven-plugin,执行完成后会在生成以下文件:


    2018-12-04swaggermarkup 生成静态文件_第4张图片
    image.png

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


    2018-12-04swaggermarkup 生成静态文件_第5张图片
    image.png

4、HTML转为PDF

目前不进行插件转化为PDF,通过打印的页面的方式另存为pdf文件:
2018-12-04swaggermarkup 生成静态文件_第6张图片
image.png

你可能感兴趣的:(2018-12-04swaggermarkup 生成静态文件)