REST API
REST 应用程序接口
REST API 是以订单、用户等资源为中心的 HTTP 接口。每次请求都要带齐所需信息，并遵守标准 HTTP 语义，也可支持缓存和多层架构。
另一个例子
仓储应用读取 `/orders/784`，用带条件的 `PATCH` 修改配送地址，再按 `Link` 响应头前往跟踪资源。任何无状态服务器都能处理请求。如果 `ETag` 已过期，服务器会返回 412，不会覆盖较新的修改。
主要部分
- 01资源标识符
- 02统一 HTTP 操作
- 03表示与链接
什么时候用
当产品适合使用面向资源的 HTTP、缓存、中间层，而且客户端需要独立演进时，可以采用 REST。
什么时候不要用
API 不是只要通过 HTTP 传 JSON 就叫 RESTful。有状态会话、RPC 命令通道，或忽略 HTTP 语义，都是不同的设计。
代码里的名称
client-server + stateless + cache + uniform interface + layered system + hypermedia 上线前要检查
检查接口约定、任何情况下都不能破坏的规则、授权与输入限制。测试重试、重复执行只生效一次、超时与部分失败。验证数据完整性、兼容性、监控、恢复与回到上一版。
预期结果：为这套系统设计或检查 REST 应用程序接口 (REST API)，并让数据保持正确、安全且容易维护。 用户场景：仓储应用读取 `/orders/784`，用带条件的 `PATCH` 修改配送地址，再按 `Link` 响应头前往跟踪资源。任何无状态服务器都能处理请求。如果 `ETag` 已过期，服务器会返回 412，不会覆盖较新的修改。 技术概念或控制措施：REST 应用程序接口 (REST API)。 适用理由：当产品适合使用面向资源的 HTTP、缓存、中间层，而且客户端需要独立演进时，可以采用 REST。 不应使用的情况：API 不是只要通过 HTTP 传 JSON 就叫 RESTful。有状态会话、RPC 命令通道，或忽略 HTTP 语义，都是不同的设计。 工程要求：定义输入、输出、接口约定，以及任何情况下都不能破坏的规则。说明授权与输入检查范围。定义失败、超时、重试和重复执行只生效一次的规则。也要定义数据迁移与兼容限制。 运营要求：加入监控信号与隐藏敏感数据的日志。设置容量上限并写好操作手册。测试恢复与回到上一版的流程。 验收标准：接口约定与失败路径测试通过。重试或部分失败时，数据与授权规则仍正确。性能上限、监控、恢复与回到上一版的方法都已验证。 证据与限制（证据边界）：没有一份官方标准能涵盖全部内容。不同团队、平台或框架的用法可能不同。 待确认：程序运行环境、数据位置、流量形态、数据一致需求和安全边界。也要确认兼容周期、服务目标（SLO）与恢复上一版的限制。
检查这份需求
请 AI 编程助手检查当前如何使用 REST 应用程序接口 (REST API)。 定义：REST API 是以订单、用户等资源为中心的 HTTP 接口。每次请求都要带齐所需信息，并遵守标准 HTTP 语义，也可支持缓存和多层架构。 生产环境检查：检查接口约定、任何情况下都不能破坏的规则、授权与输入限制。测试重试、重复执行只生效一次、超时与部分失败。验证数据完整性、兼容性、监控、恢复与回到上一版。 修改程序前，先列出看到的证据、缺口、严重程度，以及最小且安全的修正。