如何创建可测试的 api使用 @data 和 lombok 简化实体类代码。使用 assertj 验证 api 响应。使用 mockmvc 模拟请求和响应以测试控制器。
Java 框架中创建可测试 API 的指南
创建可测试的 API 是确保软件质量和可维护性的关键。本指南将介绍使用 Spring Boot 框架创建可测试 REST API 的最佳实践。
- 使用 @Data 和 Lombok
立即学习“Java免费学习笔记(深入)”;
@Data 注解由 Lombok 库提供,它生成getter、setter 和 toString 方法,简化了实体类代码。这使 API 响应易于测试。@Data
public class User {
private Long id;
private String username;
private String email;
}登录后复制登录后复制2. 使用 AssertJAssertJ 库提供简洁易用的断言语法,用于验证 API 响应。import static org.assertj.core.api.Assertions.*;
assertThat(user.getUsername()).isEqualTo("john");
assertThat(user.getEmail()).isEqualTo("john@example.com");登录后复制3. 使用 MockMVCMockMVC 是 Spring Boot 测试模块的一部分,它提供了一种模拟请求和响应的方法,以便测试控制器。@ExtendWith(SpringExtension.class)
@WebMvcTest(UserController.class)
public class UserControllerTest {
@Autowired
private MockMvc mockMvc;
@Test
public void shouldGetUser() throws Exception {
mockMvc.perform(get("/api/users/1"))
.andExpect(status().isOk())
.andExpect(content().json("{\"id\": 1, \"username\": \"john\"}"));
}
}登录后复制实战案例让我们考虑一个简单的 API,用于创建用户。实体类:@Data
public class User {
private Long id;
private String username;
private String email;
}登录后复制登录后复制控制器:@RestController
@RequestMapping("/api/users")
public class UserController {
@PostMapping
public User createUser(@RequestBody User user) {
// 服务逻辑,例如保存用户到数据库
return user;
}
}登录后复制测试类:@ExtendWith(SpringExtension.class)
@WebMvcTest(UserController.class)
public class UserControllerTest {
@Autowired
private MockMvc mockMvc;
@Test
public void shouldCreateUser() throws Exception {
User user = new User(null, "john", "john@example.com");
mockMvc.perform(post("/api/users")
.contentType(MediaType.APPLICATION_JSON)
.content(asJsonString(user)))
.andExpect(status().isOk())
.andExpect(content().json("{\"id\": 1, \"username\": \"john\"}"));
}
}登录后复制以上就是Java框架如何创建可测试的API?的详细内容,更多请关注php中文网其它相关文章!
91资源网站长-冰晨2024-08-27 17:15
发表在:【账号直充】爱奇艺黄金VIP会员『1个月』官方直充丨立即到账丨24小时全天秒单!不错不错,价格比官方便宜
91资源网站长-冰晨2024-08-27 16:15
发表在:2022零基础Java入门视频课程不错,学习一下