跳至主要内容
所有帖子作者

jesse

OpenAPI 是人!

作者 博客

在 2020 年 API 规范大会期间,OpenAPI 社区的有影响力成员聚集在一起,讨论了使 OpenAPI Initiative 顺利运行的人员和流程。

不同公司之间的协作是 OpenAPI 社区最显著的方面之一。竞争对手认识到为 API 创建标准化描述的重要性,并团结起来实现共同目标。在最近的一次讨论中,有影响力的社区成员庆祝了 OpenAPI 的成就,并回顾了它的发展历程。

此次谈话的特色人物包括:

Mitchell 讨论了如何在她的工作中实施 OpenAPI 描述如何改善开发者体验,帮助内部开发,并允许非技术开发者更好地理解内容。她还提供了关于开发者如何为 OpenAPI 做贡献的见解。

任何开发者都可以加入技术开发者社区,并参与社区活动。这是一个提问和分享知识的好地方。另一方面,技术指导委员会 (TSC) 由当选成员组成,他们负责做出高层决策,以确保 OpenAPI 顺利运行。Gardiner 和 Miller 都是 TSC 的成员,他们讨论了为 OpenAPI 添加新功能的一些困难之处。

OpenAPI 规范必须满足开发者的需求,但也必须对新手来说易于理解。平衡功能和复杂性是一项微妙的工作,TSC 通常对添加不必要的功能持谨慎态度。但是,他们会倾听社区的声音,并在对某个特定主题的兴趣日益浓厚时做出回应。

有关如何为 OpenAPI Initiative 做贡献的更多信息,请访问 网站

  • 参与 TSC 每周网络会议
  • 成为 OpenAPI Initiative 的成员
  • 观看 OpenAPI 是人!会话的视频录制

从 0 到 OpenAPI:GitHub 如何描述一个 10 年历史的 API

作者 博客

GitHub 最近调整了他们庞大而古老的 API,以符合当前的 OpenAPI 标准。在 API 规范大会上,我们有机会从该项目的领导者那里了解他们如何完成了这一壮举。

GitHub 最近发布了他们 REST API 的 OpenAPI 描述。现在比以往任何时候都更容易使用简单、标准化的 API 调用将项目与 GitHub 数据集成。然而,GitHub 的 API 团队在描述他们庞大的 API 时遇到了许多挑战,以使其符合 OpenAPI 规范。在某个时候,他们的 API 出现了超过 37,000 个错误和 500 个无效操作符!

他们对这些挑战的独特解决方案的引人入胜的解释可在 此处 获取。

对 OpenAPI 规范的简要描述

  • OpenAPI 规范 (OAS) 为 HTTP API 定义了一个标准的、与编程语言无关的接口描述,它允许人和计算机在不需要访问源代码、其他文档或检查网络流量的情况下发现和理解服务的各项功能。”

GitHub 采用 OpenAPI 规范来描述他们的 API,以便自动化 SDK 和文档。使用 OpenAPI 描述还有助于确保 API 用户的一致开发者体验。最后,实施 OpenAPI 描述简化和标准化了系统,使 GitHub 的 API 团队可以腾出精力来处理项目的其他方面。

GitHub 开源 REST API 可在以下链接获取:

https://github.com/github/rest-api-description

GitHub REST API 文档:

https://githubdocs.cn/en/rest/overview/resources-in-the-rest-api