懂AI
api-guidelines

api-guidelines

adidas开源的API设计与开发指南

adidas开源的API设计和开发指南，涵盖通用原则、REST和异步API规范。该指南旨在提高API开发效率，增强协作性和可扩展性。项目提供详细规则集用于验证API文档，支持Spectral工具自动化验证。遵循MIT许可证，为API设计社区贡献最佳实践。

API指南adidas设计规范OpenAPISpectralGithub开源项目
访问官网GitHub文档

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

adidas API指南

adidas标志

许可证：MIT

在GitBook上在线阅读

动机

本文档的目标是促进adidas所有API用户的工作并最小化他们的努力，同时保护他们的投资并鼓励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

编辑推荐精选

TRAE编程

TRAE编程

AI辅助编程，代码自动修复

Trae是一种自适应的集成开发环境（IDE），通过自动化和多元协作改变开发流程。利用Trae，团队能够更快速、精确地编写和部署代码，从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能，是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
蛙蛙写作

蛙蛙写作

AI小说写作助手，一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台，涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能，助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
问小白

问小白

全能AI智能助手，随时解答生活与工作的多样问题

问小白，由元石科技研发的AI智能助手，快速准确地解答各种生活和工作问题，包括但不限于搜索、规划和社交互动，帮助用户在日常生活中提高效率，轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手，它拥有超精准的音频识别翻译能力，几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球，无论你是留学生、商务人士、韩剧美剧爱好者，还是出国游玩、多国会议、跨国追星等等，都可以满足你所有需要同传的场景需求，线上线下通用，扫除语言障碍，让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word，让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目，能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定，还是学生群体的职业生涯规划、实习避坑指南，亦或是活动策划、旅游攻略等内容，它都能提供支持，帮助用户精准表达，轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级，全面对标OpenAI o1

科大讯飞的星火大模型，支持语言理解、知识问答和文本创作等多功能，适用于多种文件和业务场景，提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台，涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能，能为不同需求的用户提供便捷高效的帮助，助力用户轻松获取信息、解决问题，满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目，由多个知名机构联合参与。该项目提供了高效的 LLM（大语言模型）驱动的语音合成方案，支持语音克隆和语音创建功能，可通过命令行界面（CLI）和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数，生成高质量的语音。该项目适用于多种场景，如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力，做PPT更简单！

咔片是一款轻量化在线演示设计工具，借助 AI 技术，实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT，提供海量模板、智能美化、素材替换等功能，适用于销售、教师、学生等各类人群，能高效制作出高品质 PPT，满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文，一站式创作，让内容运营更高效

讯飞绘文，一个AI集成平台，支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容，加速品牌传播，提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台，公文写作神器

AI 材料星，专业的 AI 公文写作辅助平台，为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能，支持 30 + 文稿类型生成，助力快速完成领导讲话、工作总结、述职报告等材料，提升办公效率，是体制打工人的得力写作神器。

下拉加载更多