---

描述：adidas API设计和开发指南

adidas API指南

在GitBook上在线阅读

动机

本文档的目标是促进adidas所有API用户的工作并最小化他们的努力，同时保护他们的投资并鼓励API的采用。

这些指南为协作、稳定性和可扩展性奠定了基础。

指南

API指南分为两个主要部分：

• 通用指南
• API类型特定指南
  • REST API指南
  • 异步API指南

通用指南部分讨论了与任何类型API相关的核心原则。API类型特定部分进一步定义了特定于给定架构风格或API技术（如REST、Kafka或GraphQL API）的指南。

如何阅读指南

这些指南可在GitBook上在线阅读。源代码可在GitHub上找到。

这些指南中的大写单词具有特殊含义：

本文档中的关键词"必须"、"禁止"、"要求"、"应"、"不应"、
"应该"、"不应该"、"推荐"、"可以"和"可选"
应按照RFC2119中的描述进行解释。

详情请参阅RFC2119。

根据OpenAPI规范验证您的API指南

在ruleset.md文件中，您可以找到API指南规则的摘要，可用于验证您的API描述文档。如果您使用OpenAPI规范作为API描述格式，还可以利用.spectral.yaml规则集使用Spectral自动验证您的规范合规性。

要安装Spectral，您需要Node.js和一个包管理器（npm或yarn）。

注意：与spectal规范一起使用的版本是5.3.0

npm install -g @stoplight/spectral@5.3.0

# 或

yarn global add @stoplight/spectral@5.3.0

安装完成后，要使用spectral验证您的OAS文件，请执行spectral lint <oas-file> -r <adidas-api-guidelines-folder>/.spectral.yaml，其中<adidas-api-guidelines-folder>/.spectral.yaml指示.spectral.yaml文件的位置。

有关Spectral的更多文档，请参阅他们的文档。

问题与评论

如有问题，请联系 jesusjavier.dediego@adidas.com。

预期用例

本项目旨在为adidas的API设计和开发提供指南。

adidas不对将此软件用于描述的用例之外的其他目的负责。

最后审查

2024年5月

许可证和软件信息

© adidas AG

adidas AG根据MIT许可证的条款发布此软件和随附文档（如果有），目的是通过我们认为也可能对其他人有用的工具和库来帮助社区。您将在此包的根文件夹中找到MIT许可证的副本。MIT许可证未明确授予您的所有权利仍然是adidas AG的唯一和专有财产。

注意：该软件仅为提供API设计和开发指南而设计。该软件并非设计、测试或验证用于任何生产用途，也不适用于与高风险环境相关的任何用途，如医疗保健、高度或完全自动驾驶、发电厂或其他关键基础设施或服务。

如果您想就该软件联系adidas，可以发送邮件至_software.engineering@adidas.com_。

更多信息请查看adidas条款和条件页面。

许可证

MIT