7 RESTful 规范

7 RESTful 规范

RESTful 规范是目前企业开发中主流的 API 设计风格(几乎所有互联网项目都会用),核心是 "用 HTTP 协议的特性来定义接口的语义"------ 简单说就是 "通过 URL 表示资源,通过 HTTP 方法表示对资源的操作"。

7.1 RESTful 的核心规则

RESTful 规范的核心是 **"资源"+"操作" 分离 **:

  • 资源:用 URL 表示(比如 "购物车项" 是资源,URL 写成/cart/items);
  • 操作:用 HTTP 方法表示(比如 "查、增、删" 对应 GET/POST/DELETE)。
  1. 规则 1:URL 表示 "资源",不用动词
    ❌ 非 RESTful(URL 里带 "操作动词"):

    /getCartItems // 查购物车
    /addCartItem // 加购物车
    /deleteCartItem // 删购物车项

✅ RESTful 写法(URL 只写资源,用 HTTP 方法表示操作):

复制代码
GET    /cart/items   → 查购物车项(比如:对应controller的`getCartItems`方法)
POST   /cart/items   → 加购物车项(比如:对应controller的`addItemToCart`方法)
DELETE /cart/items/{itemId} → 删购物车项(比如:对应controller的`removeItemFromCart`方法)

/cart/items是 "购物车项" 这个资源,HTTP 方法决定是 "查、增、删"。

  1. 规则 2:用 HTTP 方法表示 "操作"
    RESTful 中 HTTP 方法的对应关系,比如:

|---------|---------|----------------------------------------|----------|
| HTTP 方法 | 操作 | 你的接口示例 | 作用 |
| GET | 查(读) | @GetMapping("/cart/items") | 获取购物车列表 |
| POST | 增(创建) | @PostMapping("/cart/items") | 新增购物车项 |
| DELETE | 删(删除) | @DeleteMapping("/cart/items/{itemId}") | 删除指定购物车项 |
| PUT | 改(全量更新) | @PutMapping("/cart/items/{itemId}") | 更新购物车项数量 |

  1. 规则 3:用路径参数表示 "单个资源"
    比如删除 "某个购物车项" 的接口:

    @DeleteMapping("/cart/items/{itemId}")
    public Result removeItemFromCart(@PathVariable Long itemId) { ... }

  • URL 中的{itemId}是 "路径参数",表示 "单个购物车项资源";
  • 对应 RESTful 的 "操作单个资源" 语义(比如/cart/items/123就是 "ID 为 123 的购物车项")。

7.2 在企业中的应用

现在几乎所有企业级项目(尤其是前后端分离、微服务项目)都采用 RESTful 规范,原因是:

  1. 接口语义清晰:看 URL 和 HTTP 方法就知道是 "操作什么资源、做什么事",比如DELETE /cart/items/123,不用看文档就知道是 "删除 ID 为 123 的购物车项";
  2. 前后端协作高效:前端开发者不用记 "接口叫什么名字",只需要按 "资源 + 方法" 的逻辑调用;
  3. 兼容各种框架 / 工具:Swagger、Postman 等工具都对 RESTful 接口有友好支持,自动生成文档、调试更方便;
  4. 易扩展:比如后续要加 "修改购物车项",直接用PUT /cart/items/{itemId},接口风格统一,维护成本低。
相关推荐
码事漫谈1 小时前
当公司不久后变成冒险者公会,我担心什么
后端
Csvn3 小时前
Nginx 负载均衡进阶与健康检查:哈希、keepalive 池与 DNS 自愈
后端·nginx
皮皮林5513 小时前
京东又开源一款新框架,用起来真优雅!
后端
学长毕设3 小时前
基于SpringBoot智慧养老服务平台设计与实现-附源码
java·spring boot·后端
行百里er6 小时前
【Spring Insight 技术分享】跨服务调用链路是怎么串起来的?
后端·spring·开源
火山引擎和TA的超级拍档们6 小时前
产品情报局 11 | AI 数据湖 LAS:打造大模型时代多模态数据底座
前端·后端
源动力技术栈7 小时前
C# 集合类型全览:从 List<T> 到 FrozenDictionary,配一组实测数据
后端
aleimu7 小时前
Windows 11 右键打开 Cmder 2.0:从找不到菜单到默认使用 Cmder
前端·人工智能·后端
货拉拉技术7 小时前
AI Agent 如何进入实时交易系统:货拉拉的三个实践与一套工程方法论
后端·架构·agent
我是谁的程序员7 小时前
iOS 性能分析在 Windows 上怎么做,用 KXBuild 的 kxdevice 替代 Instruments
后端·ios