GitHub 最近调整了他们庞大而古老的 API，以符合当前的 OpenAPI 标准。在 API 规范大会上，我们有机会从项目的领导者那里了解他们是如何完成这一壮举的。
GitHub 最近发布了他们 REST API 的 OpenAPI 描述。现在，使用简单、标准化的 API 调用将项目与 GitHub 数据集成比以往任何时候都更容易。然而，GitHub 的 API 团队在描述他们的庞大 API 以符合 OpenAPI 规范方面遇到了许多挑战。在某个时刻，他们的 API 出现了超过 37,000 个错误和 500 个无效操作符！
他们对这些挑战的独特解决方案的引人入胜的解释可在 此处 获得。
OpenAPI 规范的简要描述
- “OpenAPI 规范 (OAS) 为 HTTP API 定义了标准的、与编程语言无关的接口描述，它允许人类和计算机在不需要访问源代码、附加文档或检查网络流量的情况下发现和理解服务的 capabilities。”
GitHub 为其 API 采用 OpenAPI 规范以自动化 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