39、RESTful Web API 实践指南

RESTful Web API 实践指南

1. 应用策略

在应用相关策略时，顺序并非固定不变，需依据实际情况调整。不同策略有不同特点：
- 建议型 ：如某些策略主要提供建议。
- 实施指南型 ：像一些策略是详细的实施指南。
- 协作依赖型 ：部分策略高度依赖 API 消费者和生产者之间的合作。
- 独立实施型 ：有些策略在设计或构建时无需直接的客户端 - 服务器交互即可实施。

对策略进行分类，明确哪些可独立应用，哪些需要各方紧密合作，有助于确定哪些策略能在初始时间和资源投入上带来最大回报。使用这些策略的一个优势是能为共享事物提供通用名称，成为交流设计的语言。例如，团队虽知道处理列表分页的常见方法，但未将其作为可复用策略共享，也未在公司内统一名称，使用策略名称可使 API 实现更具一致性。

2. 设计优先

在从头构建新服务接口时，可将设计策略作为起点，无论使用 API 访问现有服务，还是同时创建接口和服务代码。这样能为 API 生产者和消费者设定新期望，避免为现有不符合规范的服务制定新接口规则的困扰。但即便从头开始，也应避免“重塑一切”，应逐步改进 API 设计。例如，设定新 API 限于固定表示格式的标准是早期的良好步骤。而支持可重复性、可逆性、可扩展性和可修改性更具挑战性，因为需要生产者和消费者在运行时理解策略的影响。

3. 客户端与服务器协作

客户端和服务端的相关内容虽独立编写，但存在一定重复和关联。编写服务接口若没有客