Swagger静态页面输出为文档、html

在开发的过程中,为了方便测试,需要进行使用swagger的页面或者knief4j,然后在页面上进行测试,也可以使用yapi,yapi可以导出word、html等信息,现将swagger的数据变成html、word、markdown。

pom依赖

 
        
            io.github.swagger2markup
            swagger2markup
            1.3.3
        
        
            io.swagger.core.v3
            swagger-core
            2.1.10
        
        
            io.swagger.core.v3
            swagger-models
            2.1.10
        
        
            org.pegdown
            pegdown
            1.6.0
        
        
            org.springframework.boot
            spring-boot-starter-test
        
    

build依赖:

    
        
            org.springframework.boot
            spring-boot-maven-plugin
        
        
            io.github.swagger2markup
            swagger2markup-maven-plugin
            1.3.7
            
                http://localhost:31396/wocloud-dashboard/v2/api-docs
                src/docs/markdown/generated/all
                
                    
                    MARKDOWN
                
            
        

        
            org.asciidoctor
            asciidoctor-maven-plugin
            2.1.0
            
                src/docs/asciidoc/generated
                src/docs/asciidoc/html
                html
                
                    
                    left
                    
                    3
                    
                    true
                
            
        
    

代码生成

    @Test
    public void generateMarkdownDocsToFile() throws Exception {
        //    输出Markdown到单文件
        Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
                .withMarkupLanguage(MarkupLanguage.MARKDOWN)
                .withOutputLanguage(Language.ZH)
                .withPathsGroupedBy(GroupBy.TAGS)
                .withGeneratedExamples()
                .withoutInlineSchema()
                .build();

        Swagger2MarkupConverter.from(new URL("http://localhost:31396/wocloud-dashboard/v2/api-docs"))
                .withConfig(config)
                .build()
                .toFile(Paths.get("./docs/asciidoc/generated/all"));
    }

在执行插件或者代码之前,先把相应的目录的创建出来,不然会出现异常。

参考文献