springboot集成swagger2导出pdf和html

开发工具:idea

首先我们需要更改maven路径

图一

其次更改本地maven的setting 文件

中添加一段标签 引入阿里仓库

 

    aliyunmaven

       *

         阿里云公共仓库 

         https://maven.aliyun.com/repository/public 

    

在pom.xml 中添加

 

    nl.jworks.markdown_to_asciidoc 

    markdown_to_asciidoc 

    1.1

    

    

    io.github.swagger2markup 

    swagger2markup 

    1.3.1

      

在pom.xml中的 plugins 标签下增加这段代码

 

io.github.swagger2markup 

swagger2markup-maven-plugin 

1.2.0 

 

 http://localhost:8084/

 src/docs/asciidoc/generated 

    

  ASCIIDOC 

 

          

 

org.asciidoctor 

asciidoctor-maven-plugin 

1.5.3 

        

 

 

org.asciidoctor 

asciidoctorj-pdf  

1.5.0-alpha.16 

   

    

org.jruby    

jruby-complete

 1.7.24

  

 src/docs/asciidoc/generated 

coderay 

left

 

 

output-html

 generate-resources

process-asciidoc

html5 

 src/docs/asciidoc/html 

   

output-pdf generate-resources process-asciidoc pdf src/docs/asciidoc/pdf    

这是我们回归项目中 maven 重新clear


图二

在controller中编写测试类

@RunWith(SpringRunner.class)

public class ExportConfig { 

@Test 

public void generateAsciiDocs() throws Exception { 

    // 输出Ascii格式     

    Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder().withMarkupLanguage(MarkupLanguage.ASCIIDOC)         .withOutputLanguage(Language.ZH).withPathsGroupedBy(GroupBy.TAGS).withGeneratedExamples()         .withoutInlineSchema().build(); 

      Swagger2MarkupConverter.from(new URL("http://localhost:8098/v2/api-docs")).withConfig(config)         .build().toFolder(Paths.get("src/docs/asciidoc/generated")); 

     }   

}  

启动需要导出接口文档的项目

紧接着启动测试类方法 generateAsciiDocs();

若使用的idea,在terminal中执行:mvn asciidoctor:process-asciidoc

执行:mvn generate-resources

完毕!!!运行结果在src/docs目录中可以看到。。

本人亲测有效,如有疑问可随时留言。

你可能感兴趣的:(springboot集成swagger2导出pdf和html)