# @octokit/openapi-types 中文文档

规范地址：https://npmcn.com/package/%40octokit/openapi-types/

版本：29\.0\.1
npm 元数据更新时间：2026-08-29T15:48:55.997Z
中文译文更新时间：2026-11-05T15:54:07.196Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40octokit/openapi-types
原文对照：https://npmcn.com/package/%40octokit/openapi-types/?lang=original
项目主页：https://github.com/octokit/openapi-types.ts#readme
源码仓库：https://github.com/octokit/openapi-types.ts

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：5.3 MB，4 个文件
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2020-10-29T00:04:05.198Z
- 最新版本发布：2026-08-29T15:48:55.670Z
- 近 30 天下载量：307861621（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：162（近 12 个月 3 个）

## 中文简介

基于 GitHub 的 OpenAPI spec for api.github.com 生成类型脚本定义

## 安装

```sh
npm install @octokit/openapi-types
```

也可以使用：`pnpm add @octokit/openapi-types`、`yarn add @octokit/openapi-types`、`bun add @octokit/openapi-types`

## README

# @ octokit/ openapi 类型

> 基于 GitHub 的 OpenAPI 光谱生成类型脚本定义

此软件包基于 [GitHub 的 OpenAPI 规格](https://github.com/github/rest-api-description/)

## 使用量

```ts
import { components } from "@octokit/openapi-types";

type Repository = components["schemas"]["full-repository"];
```

## 许可证

[麻省理工学院](https://npmcn.com/package/%40octokit/openapi-types/LICENSE)

## 常见问题

### @octokit/openapi-types 是什么？

基于 GitHub 的 OpenAPI spec for api\.github\.com 生成类型脚本定义

### 如何安装 @octokit/openapi-types？

在项目目录运行 npm install @octokit/openapi-types，或使用 pnpm add / yarn add / bun add。

### @octokit/openapi-types 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @octokit/openapi-types 可以商用吗？

@octokit/openapi-types 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @octokit/openapi-types 的下载量有多少？

根据 npm 官方下载统计，@octokit/openapi-types 在 2026/10/07 – 2026/11/05 这 30 天内被下载 307,861,621 次，日均约 10,262,054 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @octokit/openapi-types 还在维护吗？

最新版本 29\.0\.1 发布于 2026/08/29（2 个月前）；至今共发布 162 个版本，其中过去 12 个月发布了 3 个；首次发布于 2020/10/29。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。