Skip to main content

此版本的 GitHub Enterprise 将停止服务 2022-10-12. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

OpenAPI 描述

OpenAPI 3.0 标准文档中全面描述了 GitHub Enterprise Server REST API。

关于 OpenAPI 描述

OpenAPI 是用于描述 REST API 的标准规范。 OpenAPI 描述允许人类和计算机无需首先阅读文档或了解实现实现即可发现 API 的功能。 GitHub 已经以 OpenAPI 3.0 标准文档的形式公开其 REST API。

获取 GitHub OpenAPI 描述

可以在开放源代码 REST API OpenAPI 说明存储库中找到说明。

我们以两种格式提供描述。 捆绑版本适用于大多数情况,因为它包括可重用且可读的 OpenAPI 组件。 如果您的工具不支持对组件的内联引用,我们还提供完全取消引用的版本。

使用 GitHub OpenAPI 描述

OpenAPI 描述有很多用途。 例如,可以:

  • 生成您自己的 API 客户端。
  • 验证并测试 GitHub REST API 集成。
  • 使用第三方工具(如 Insomnia 或 Postman)探索 GitHub Enterprise Server REST API 并与之交互。

例如,GitHub 使用 REST OpenAPI 说明来生成 GitHub Enterprise Server REST API 参考文档