我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

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 参考文档

此文档对您有帮助吗?

Privacy policy

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。