轻松生成API文档：Spring Rest Docs指南

2024-02-17 16:29:09

当然，以下是关于 Spring Rest Docs使用的文章：

Spring Rest Docs是一款用于通过代码生成API文档的强大工具。它可以在单元测试中额外添加API信息，从而自动生成对应的文档片段。

使用Spring Rest Docs生成API文档

1. 准备工作

在使用Spring Rest Docs之前，需要先进行一些准备工作：

添加依赖：

<dependency>
    <groupId>org.springframework.restdocs</groupId>
    <artifactId>spring-restdocs-core</artifactId>
    <version>2.0.5.RELEASE</version>
</dependency>

创建测试类：

@RunWith(SpringRunner.class)
@SpringBootTest
public class MyControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @Rule
    public RestDocumentation restDocumentation = new RestDocumentation("target/generated-snippets");
}

创建MockMvc实例：

mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext)
        .addFilters(new CorsFilter())
        .apply(documentationConfiguration(restDocumentation))
        .build();

定义测试用例：

@Test
public void testExample() throws Exception {
    mockMvc.perform(get("/example"))
            .andExpect(status().isOk())
            .andDo(document("example"));
}