Zalando RESTful API和事件指南
内容提要
这篇文章是关于Zalando RESTful API和事件指南的。它介绍了Zalando的软件架构和API设计原则，以及REST基础知识和HTTP请求的准则。文章还提到了超媒体和性能设计，以及事件类型和活动设计。
延伸解读
API优先与微服务解耦的实践意义
Zalando将API优先作为核心工程原则，要求微服务开发从代码外部的API定义开始，并经过同行评审。这有助于确保API易于理解、通用且风格一致，从而支持解耦微服务架构。对于团队而言，这意味着在编写实现代码前需先设计并评审OpenAPI规范，以促进高质量API的产出和跨团队协作。
REST设计中的关键约束与选择
指南在REST基础方面提出了多项必须遵循的约束，如使用JSON作为负载格式、属性名采用蛇形命名法、URL中资源名用复数且避免动词。同时，在分页上推荐基于游标而非偏移量，并避免返回总结果计数。这些选择旨在提升API的兼容性、性能和一致性，减少后续破坏性变更的风险。
事件设计的兼容性与安全考量
事件被视为服务接口的一部分，必须定义符合整体API指南的事件类型，并提供强制性元数据。设计时应避免将敏感数据写入事件，并确保事件的向后兼容性。消费端需能防止重复并处理乱序，这要求事件设计具备幂等性和明确的排序机制，以保障系统间可靠通信。
版本控制与弃用策略的谨慎态度
指南明确不得使用URL版本控制，而应使用媒体类型版本控制，并避免版本控制。对于弃用，必须反映在API规范中，获得客户批准并监控使用情况，同时在响应中添加Deprecation和Sunset标头。这些要求体现了对API长期稳定性和外部合作伙伴关系的重视，旨在减少破坏性变更。
Q&A
Zalando的RESTful API设计原则是什么？
Zalando的RESTful API设计原则包括解耦微服务、API优先、易于理解和学习、通用性、坚固性和一致性。
如何确保Zalando API的安全性？
Zalando API的安全性通过保护端点、定义和分配权限，以及遵循权限命名约定来确保。
Zalando API使用的有效负载数据交换格式是什么？
Zalando API必须使用JSON作为有效负载数据交换格式。
Zalando的事件设计中需要遵循哪些要求？
事件设计中必须确保事件符合整体API指南，并提供强制性事件元数据和唯一的事件标识符。
Zalando API的URL设计应遵循哪些原则？
Zalando API的URL设计应使用复数形式的资源名称，不应包含动词，并保持URL不含空路径段和尾部斜杠。
Zalando API如何处理版本控制？
Zalando API必须使用媒体类型版本控制，不得使用URL版本控制，并始终返回JSON对象作为顶级数据结构。
