Swagger2markdown使用文档

Swagger2markdown是一种将swagger生成的接口文档转化为markdown格式文档的工具，使用很简便，下面是详细说明。

一、使用环境的构建

1.构建一个使用了swagger的spring-boot-web工程：

2.修改pom.xml，加入swagger2markdown依赖

    <dependency>
        <groupId>io.github.swagger2markup</groupId>
        <artifactId>swagger2markup</artifactId>
        <version>1.3.1</version>
    </dependency>

3.创建一个junit测试类，也可以用构建项目时，默认生成的测试类

import java.net.URL;
import java.nio.file.Paths;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import io.github.swagger2markup.Swagger2MarkupConfig;
import io.github.swagger2markup.Swagger2MarkupConverter;
import io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder;
import io.github.swagger2markup.markup.builder.MarkupLanguage;

@RunWith\(SpringRunner.class\)
@SpringBootTest
public class Swagger2markdown1ApplicationTests {

    @Test
    public void genrateMarkdown\(\) throws Exception {

        Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder\(\).withMarkupLanguage\(MarkupLanguage.MARKDOWN\).build\(\);



        Swagger2MarkupConverter.from\(new URL\("http://localhost:8080/javashop/v2/api-docs?group=%E5%85%A8%E9%83%A8%E5%88%86%E7%BB%84"\)\)
                .withConfig\(config\).build\(\).toFolder\(Paths.get\("src/test"\)\);
    }
}

URL的意思是http://localhost:8080/javashop/v2/api-docs?group=全部分组

src/test是指生成的md文件保存在src下的test文件夹里

4.test文件夹里保存的md文件

Definitions 文件中包含使用了swagger的参数类和实体类

Overview文件中包含使用了swagger的controller

Paths文件包含了接口信息

Security是空的