RESTful 设计要点

71.11 RESTful 设计要点

URL 用名词表示资源:/api/students 而非 /api/getStudents。

GET 查、POST 增、PUT 改、DELETE 删;不要所有操作都用 GET。

统一响应格式 {code, message, data};HTTP 状态码与业务 code 配合使用。

分页:GET /api/students?page=1&size=10;搜索:?keyword=小明。

  • GET /api/students — 列表
  • GET /api/students/1 — 详情
  • POST /api/students — 新增
  • PUT /api/students/1 — 修改
  • DELETE /api/students/1 — 删除