如何创建可测试的 api使用 @data 和 lombok 简化实体类代码。使用 assertj 验证 api 响应。使用 mockmvc 模拟请求和响应以测试控制器。
Java 框架中创建可测试 API 的指南
创建可测试的 API 是确保软件质量和可维护性的关键。本指南将介绍使用 Spring Boot 框架创建可测试 REST API 的最佳实践。
1. 使用 @Data 和 Lombok
zvvq.cn
@Data 注解由 Lombok 库提供，它生成getter、setter 和 toString 方法，简化了实体类代码。这使 API 响应易于测试。 本文来自zvvq
1
2
zvvq
3 zvvq
4
5 zvvq好，好zvvq
6
内容来自zvvq
@Data
public class User { copyright zvvq
private Long id; zvvq好，好zvvq
private String username;
zvvq.cn
private String email;
zvvq好，好zvvq
}
内容来自zvvq
2. 使用 AssertJ 内容来自zvvq
AssertJ 库提供简洁易用的断言语法，用于验证 API 响应。 内容来自samhan
1 本文来自zvvq
2 内容来自zvvq，别采集哟
3
4
import static org.assertj.core.api.Assertions.;
zvvq.cn
assertThat(user.getUsername()).isEqualTo("john"); zvvq
assertThat(user.getEmail()).isEqualTo("john@example.com");
3. 使用 MockMVC zvvq
MockMVC 是 Spring Boot 测试模块的一部分，它提供了一种模拟请求和响应的方法，以便测试控制器。
1 zvvq.cn
2
zvvq好，好zvvq
3 内容来自zvvq
4
本文来自zvvq
5 本文来自zvvq
6 本文来自zvvq
7 内容来自samhan
8 内容来自zvvq
9 zvvq.cn
10 内容来自zvvq
11
12 zvvq
13 本文来自zvvq
14 zvvq
@ExtendWith(SpringExtension.class)
@WebMvcTest(UserController.class) zvvq
public class UserControllerTest { 内容来自zvvq，别采集哟
@Autowired 内容来自zvvq，别采集哟
private MockMvc mockMvc;
本文来自zvvq
@Test zvvq好，好zvvq
public void shouldGetUser() throws Exception {
zvvq.cn
mockMvc.perform(get("/api/users/1")) 内容来自samhan
.andExpect(status().isOk())
.andExpect(content().json("{\"id\": 1, \"username\": \"john\"}"));
} 本文来自zvvq
}
实战案例
让我们考虑一个简单的 API，用于创建用户。 本文来自zvvq
实体类： 内容来自samhan
1
zvvq
2 内容来自zvvq
3
4 本文来自zvvq
5
内容来自zvvq
6 内容来自samhan666
@Data 内容来自samhan
public class User { 内容来自zvvq，别采集哟
private Long id;
zvvq好，好zvvq
private String username;
private String email;
copyright zvvq
} zvvq
控制器：
zvvq
1 内容来自samhan666
2 zvvq.cn
3 内容来自samhan
4 zvvq.cn
5
6 zvvq好，好zvvq
7 zvvq好，好zvvq
8 zvvq.cn
9 zvvq好，好zvvq
10 本文来自zvvq
@RestController
@RequestMapping("/api/users")
zvvq.cn
public class UserController {
@PostMapping copyright zvvq
public User createUser(@RequestBody User user) { 内容来自zvvq
// 服务逻辑，例如保存用户到数据库
return user;
}
zvvq
}
测试类： zvvq.cn
1 内容来自zvvq，别采集哟
2 本文来自zvvq
3 copyright zvvq
4
5 内容来自zvvq，别采集哟
6
7 copyright zvvq
8
zvvq好，好zvvq
9 本文来自zvvq
10
11
12
内容来自samhan
13 zvvq.cn
14
内容来自zvvq，别采集哟
15 zvvq
16
copyright zvvq
17
本文来自zvvq
@ExtendWith(SpringExtension.class)
zvvq好，好zvvq
@WebMvcTest(UserController.class) 内容来自zvvq
public class UserControllerTest {
@Autowired
private MockMvc mockMvc;
@Test
内容来自zvvq
public void shouldCreateUser() throws Exception { 内容来自zvvq
User user = new User(null, "john", "john@example.com");
mockMvc.perform(post("/api/users")
本文来自zvvq
.contentType(MediaType.APPLICATION_JSON)
内容来自zvvq
.content(asJsonString(user)))
.andExpect(status().isOk()) zvvq.cn
.andExpect(content().json("{\"id\": 1, \"username\": \"john\"}")); 内容来自zvvq，别采集哟
} zvvq
} 内容来自samhan
以上就是Java框架如何创建可测试的API？的详细内容，更多请关注其它相关文章！
内容来自samhan666