{"meta":{"title":"关于 REST API 的 OpenAPI 描述","intro":"GitHub REST API 在符合 OpenAPI 的文档中进行全面介绍。","product":"REST API","breadcrumbs":[{"href":"/zh/rest","title":"REST API"},{"href":"/zh/rest/about-the-rest-api","title":"REST API 简介"},{"href":"/zh/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api","title":"OpenAPI 描述"}],"documentType":"article"},"body":"# 关于 REST API 的 OpenAPI 描述\n\nGitHub REST API 在符合 OpenAPI 的文档中进行全面介绍。\n\n## 关于 OpenAPI\n\nOpenAPI 是用于描述 REST API 接口的规范。 它描述 API，而无需访问源代码或其他文档。 规范既可供人类读取，也可供机器读取。 有关详细信息，请参阅 [OpenAPI 规范文档](https://spec.openapis.org/oas/v3.1.0)。\n\n## 关于GitHub的 OpenAPI 描述\n\nGitHubREST API 的 OpenAPI 说明已公开发布。 可以在 开放源代码 [github/rest-api-description](https://github.com/github/rest-api-description) 存储库中找到说明。\n\nGitHub 提供 3.0 和 3.1 OpenAPI 说明。\n\n对于每个说明，每个产品都有一个版本：GitHub Free/GitHub Pro/GitHub Team（）、 `api.github.com` （GitHub Enterprise Cloud`ghec`）和每个版本的GitHub Enterprise Server（）。`ghes-X.X`\n\n对于每个产品，如果支持基于日期的版本控制，则会为每个基于日期的版本提供描述。 有关详细信息，请参阅“[API 版本](/zh/rest/about-the-rest-api/api-versions)”。\n\n每个描述都以捆绑格式或取消引用格式提供。 捆绑格式使用 `$ref` 来指代在端点之间共享的 OpenAPI 组件。 取消引用的格式包括完全扩展的描述。\n\n## 使用 GitHub OpenAPI 描述\n\n由于 OpenAPI 描述是计算机可读的，因此可以使用它来执行如下操作：\n\n* 生成库以方便使用 REST API\n* 验证并测试使用 REST API 的集成\n* 使用第三方工具（如 Insomnia 或 Postman）探索 REST API 并与之交互。\n\n例如， GitHub 使用 OpenAPI 说明生成 Octokit SDK。\nGitHub 还使用 OpenAPI 说明为每个终结点生成 REST API 参考文档。"}