100  
查询码:00000580
Spring Boot Swagger静态文档的生成
作者: 倪嗣成 于 2020年12月25日 发布在分类 / 物联网组 / 边缘接入网关 下,并于 2020年12月25日 编辑
Swagger

第一步 :编辑pom.xml增加需要使用的相关依赖和仓库

  <dependency>
        <groupId>io.github.swagger2markup</groupId>
        <artifactId>swagger2markup</artifactId>
        <version>1.3.3</version>
        <scope>test</scope>
    </dependency>
</dependencies>

<repositories>
    <repository>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
        <id>jcenter-releases</id>
        <name>jcenter</name>
        <url>http://jcenter.bintray.com</url>
    </repository>
第二步 :编写一个单元测试用例来生成执行生成文档的代码


@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
public class DemoApplicationTests {

    @Test
    public void generateAsciiDocs() throws Exception {

        URL remoteSwaggerFile = new URL("http://localhost:8080/v2/api-docs");
        Path outputDirectory = Paths.get("src/docs/asciidoc/generated");

        //    输出Ascii格式
        Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
                .withMarkupLanguage(MarkupLanguage.ASCIIDOC)
                .build();


        Swagger2MarkupConverter.from(remoteSwaggerFile)
                .withConfig(config)
                .build()
                .toFolder(outputDirectory);
    }

}
在执行了上面的测试用例之后,我们就能在当前项目的src目录下获得如下内容:


src
--docs
----asciidoc
------generated
--------definitions.adoc
--------overview.adoc
--------paths.adoc
--------security.adoc
可以看到,这种方式在运行之后就生成出了4个不同的静态文件。



 推荐知识

 历史版本

修改日期 修改人 备注
2020-12-25 14:28:32[当前版本] 倪嗣成 创建版本

知识分享平台 -V 4.8.7 -wcp