后端接口设计（RESTful 风格）

1. 核心设计原则

基于 HTTP 方法语义定义接口功能，URL 仅表示资源，不包含操作动词（如 “add”“delete”）。

2. 关键注解与使用

注解 作用 应用场景
@RequestMapping 类 / 方法级路径映射，可指定 HTTP 方法 类上定义基础路径（如/api/v1）
@GetMapping 处理 GET 请求，简化 @RequestMapping (method=GET) 查询单个资源、查询资源列表
@DeleteMapping 处理 DELETE 请求 删除指定资源
@PostMapping 处理 POST 请求 新增资源
@PutMapping 处理 PUT 请求 更新资源

3. 参数传递方式

  • 路径参数：用@PathVariable("参数名")获取 URL 中的参数，如/employee/{id}中的id，适用于查询、删除单个资源。
  • 请求体参数：用@RequestBody接收 JSON 格式的请求体数据，适用于新增、更新资源时传递完整对象（如 Employee）。

4. 接口示例

1
2
3
4
5
6
7
// 查询单个员工（GET请求+路径参数）
@GetMapping("/employee/{id}")
public R<Employee> get(@PathVariable("id") Long id) { ... }

// 新增员工（POST请求+请求体）
@PostMapping("/employee")
public R add(@RequestBody Employee employee) { ... }