提示:记录 java 后端编写接口的注意事项
1 概念解读
- RESTful API:REST 架构风格的 API 设计,即前端和后端独立开发
2 注解
2.1 控制器注解
@Controller:用于接受前端请求,返回 HTML 页面;位置放在类的上方,示例如下:
@Controller // 传统 MVC 控制器
public class ViewController {
@GetMapping("/home")
public String homePage() {
return "home"; // 返回视图名
}
}
@RestController:用于接收前端请求,返回 JSON/XML 数据;位置放在类的上方,示例如下:
@RestController // 组合注解 = @Controller + @ResponseBody
public class UserController {
// 所有方法默认返回 JSON,不需要@ResponseBody
}
2.2 请求映射注解
@RequestMapping:通用请求映射,可以接收get | post | put | patch | delete,位置放在类和方法上。
@DeleteMapping:专门用于 DELETE,删除数据,示例如下:
@DeleteMapping("/users/{id}")
public void deleteUser(@PathVariable Long id) {
// 删除用户
}
@PatchMapping:专门用于 PATCH,部分更新资源,示例如下:
@PatchMapping("/users/{id}")
public User partialUpdate(@PathVariable Long id, @RequestBody Map<String, Object> updates) {
}


