如何用 Spring Boot 的 @RestController 构建一个 REST API？

Question

IT Interview Practice · Accepted Answer

Spring Boot 中的一个 REST endpoint 就是 `@RestController` 上的一个方法，映射到某个 HTTP 动词和路径。`@RestController` = `@Controller` + `@ResponseBody`，因此返回值会被直接序列化到响应体（通过 Jackson 转成 JSON），而不是被解析成一个视图。 ## 一个 CRUD controller ```java @RestController @RequestMapping("/api/users") // 下面每个方法的基础路径 public class UserController { private final UserService service; public UserController(UserService service) { this.service = service; } @GetMapping("/{id}") // GET /api/users/42 public UserDto get(@PathVariable Long id) { // 从 URL 绑定 {id} return service.findById(id); // 返回的对象 -> JSON } @PostMapping // POST /api/users @ResponseStatus(HttpStatus.CREATED) // 用 201 而非 200 public UserDto create(@Valid @RequestBody UserDto body) { // JSON -> 对象 return service.create(body); } @GetMapping // GET /api/users?role=admin public List list(@RequestParam(required = false) String role) { return service.findByRole(role); } } ``` 关键注解：`@PathVariable` 从路径中取出一个值，`@RequestParam` 读取查询字符串参数，`@RequestBody` 反序列化 JSON 载荷。加上 `@Valid` 会在你的方法运行前对传入的 DTO 触发 Bean Validation（`@NotNull`、`@Email`…）。 ## 返回恰当的状态码和响应体 ```java @GetMapping("/{id}") public ResponseEntity get(@PathVariable Long id) { return service.find(id) .map(ResponseEntity::ok) // 200 + 响应体 .orElse(ResponseEntity.notFound().build()); // 404，无响应体 } ``` ## 为什么这很重要这是后端最基本的日常工作，所以面试官期待你熟练。强的答案会提到使用 **DTO** 而非直接暴露 JPA 实体、用 `@Valid` 校验输入，以及用 `ResponseEntity` 返回正确的状态码——这正是玩具 endpoint 与真实 API 之间的区别。

一个 CRUD controller

返回恰当的状态码和响应体

为什么这很重要

相关问题