Skip to main content

此版本的 GitHub Enterprise 已停止服务 2022-06-03. 即使针对重大安全问题,也不会发布补丁。 要获得更好的性能、改进的安全性和新功能,请升级到 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 参考文档