Zalando RESTful API和事件指南


这是一套很好的开发Restful API的指南。由Zalando提供。

Zalando 的软件架构以解耦微服务为中心，通过带有 JSON 负载的 RESTful API 提供功能。小型工程团队在其 AWS（团队）账户中拥有、部署和运营这些微服务。我们的 API 最纯粹地表达了我们系统的功能，因此是非常有价值的业务资产。自从我们开始制定新的开放平台战略以来，设计高质量、持久的 API 对我们来说变得更加重要，该战略将 Zalando 从一家在线商店转变为一个广阔的时尚平台。我们的战略强调开发大量公共 API 供外部业务合作伙伴通过第三方应用程序使用。

考虑到这一点，我们采用“API 优先”作为我们的关键工程原则之一。微服务开发从代码外部的 API 定义开始，理想情况下涉及充足的同行评审反馈以实现高质量的 API。 API First 包含一套与质量相关的标准，并培育同行评审文化，包括轻量级评审程序。我们鼓励我们的团队遵循它们，以确保我们的 API：

  • 易于理解和学习
  • 是通用的，是从特定的实现和用例中抽象出来的
  • 坚固且易于使用
  • 具有共同的外观和感觉
  • 遵循一致的 RESTful 风格和语法
  • 与其他团队的 API 和我们的全球架构保持一致

理想情况下，所有 Zalando API 看起来都像是由同一位作者创建的。

本指南中使用的约定
本节中使用的要求级别关键字“必须”、“不得”、“必需”、“应”、“不应”、“应该”、“不应该”、“推荐”、“可以”和“可选”文档（不区分大小写）应按照RFC 2119中的描述进行解释。

目录