PayPal API 风格指南和设计模式

PayPal 通过 RESTful API 将自己的平台打造成彼此连接的服务。他们为此提供了用于创建和使用这些 API 的指南和设计模式，其他开发者可以在自己的项目中使用这些指南和模式。

PayPal 的 API 设计指南经过多年的开发和演化，包含了如下的一些原则。

• 低耦合：服务与消费者之间必须是低耦合的。
• 封装：一个服务只能通过其他服务提供的接口来访问不属于它的数据和功能。
• 稳定性：服务接口必须保持稳定。
• 可重用性：服务必须能够为多个上下文和多个消费者所重用。
• 基于协议：功能和数据必须通过标准的服务协议暴露出来。
• 一致性：服务必须遵循一系列规则、迭代风格、词汇表和公共类型。
• 易用性：对消费者应用程序来说，服务必须易于使用。
• 外部化（externalizable）：服务提供的功能必须易于被外部化。

业务能力以资源的形式暴露出来，这些资源都有自己的名字。为了避免重复，同一个资源只能由一个服务来提供，并通过 HTTP 方法来实现资源的 CRUD 操作：

• GET：用于获取一个资源。
• POST：用于创建一个资源，或者执行更复杂的操作。
• PUT：用于更新一个资源。
• DELETE：用于删除一个资源。
• PATCH：用于部分更新一个资源。

HTTP 通过 JSON 数据交换格式来传输数据，这些格式都定义了 JSON Schema 。Schema 支持 JSON 原始类型，如字符串、数字、枚举、数组、空值（null），以及常用类型，如地址、货币、日期、时间、国家、电话号码等。

API 指南里包含了 HATEOAS 代码示例，演示了如何使用超链接来实现 REST。还有关于如何使用 HTTP 头部字段（标准和自定义的）和状态码的指南，如映射 HTTP 方法和状态码、URI 的命名约定、查询参数、资源、错误处理、版本管理和弃用规则。PayPal 还公开了另一份文档—— API 设计模式和用例——详细说明了 API 的使用模式并提供了示例代码。

查看英文原文： PayPal’s API Style Guide and Patterns