关于 OpenAPI 描述
OpenAPI 是描述 REST API 的标准规范。 OpenAPI 描述允许人类和计算机无需首先阅读文档或了解实现实现即可发现 API 的功能。 GitHub 已经以 OpenAPI 3.0 标准文档的形式公开其 REST API。
获取 GitHub OpenAPI 描述
您可以在开源REST API OpenAPI 描述仓库中找到描述。
我们以两种格式提供描述。 The bundled version works for most cases, as it includes OpenAPI components for reuse and readability. If your tooling does not support inline references to components, we also provide a fully dereferenced version.
Using the GitHub OpenAPI description
There are many uses for an OpenAPI description. 例如，您可以：
- Generate your own API client.
- Validate and test a GitHub REST API integration.
- Explore and interact with the GitHub Enterprise Server REST API using third-party tools, such as Insomnia or Postman.
For example, GitHub uses the REST OpenAPI description to generate the GitHub Enterprise Server REST API reference documentation.