企业级SpringBoot教程 （十）用spring Restdocs建立API文档

这篇文章将带你了解如何用spring官方推荐的restdoc去生成api文档。本文建立一个简单的springboot工程，将http接口经过Api文档暴露出来。只须要经过 JUnit单元测试和Spring的MockMVC就能够生成文档。完整项目的源码来源 技术支持一七九一七四三三八零

准备工做

你须要15min

Jdk 1.8

maven 3.0+

idea

建立工程

引入依赖，其pom文件：

经过@SpringBootApplication,开启springboot

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.springframework.restdocs</groupId>
            <artifactId>spring-restdocs-mockmvc</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
复制代码

经过@SpringBootApplication,开启springboot

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}
复制代码

在springboot一般建立一个controller:

@RestController
public class HomeController {``

    @GetMapping("/")
    public Map<String, Object> greeting() {
        return Collections.singletonMap("message", "Hello World");
    }

}
复制代码

启动工程，访问localhost:8080，浏览器显示：

{“message”:”Hello World”}
复制代码

证实接口已经写好了，可是如何经过restdoc生存api文档呢

Restdoc,经过单元测试生成api文档 restdocs是经过单元测试生存snippets文件，而后snippets根据插件生成htm文档的。

建一个单元测试类：

@RunWith(SpringRunner.class)
@WebMvcTest(HomeController.class)
@AutoConfigureRestDocs(outputDir = "target/snippets")
public class WebLayerTest {

    @Autowired
    private MockMvc mockMvc;

    @Test
    public void shouldReturnDefaultMessage() throws Exception {
        this.mockMvc.perform(get("/")).andDo(print()).andExpect(status().isOk())
                .andExpect(content().string(containsString("Hello World")))
                .andDo(document("home"));
    }
}
复制代码

其中，@ AutoConfigureRestDocs注解开启了生成snippets文件，并指定了存放位置。

启动单元测试，测试经过，你会发如今target文件下生成了一个snippets文件夹，其目录结构以下：

└── target
    └── snippets
        └── home
            └── httpie-request.adoc
            └── curl-request.adoc
            └── http-request.adoc
            └── http-response.adoc
复制代码

默认状况下，snippets是Asciidoctor格式的文件，包括request和reponse，另外其余两种httpie和curl两种流行的命令行的http请求模式。 到目前为止，只生成了Snippets文件，须要用Snippets文件生成文档。