# @ahoo-wang/fetcher-openapi 中文文档

规范地址：https://npmcn.com/package/%40ahoo-wang/fetcher-openapi/

版本：6\.0\.1
npm 元数据更新时间：2026-10-04T12:11:44.116Z
中文译文更新时间：2026-11-06T12:02:26.817Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40ahoo-wang/fetcher-openapi
原文对照：https://npmcn.com/package/%40ahoo-wang/fetcher-openapi/?lang=original
项目主页：https://github.com/Ahoo-Wang/fetcher/tree/main/packages/openapi
源码仓库：https://github.com/Ahoo-Wang/fetcher

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

- 包体积（解压后）：101 kB，62 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.20\.8
- 运行依赖：0 个
- 首次发布：2025-09-18T10:15:45.843Z
- 最新版本发布：2026-10-04T12:11:43.775Z
- 近 30 天下载量：3297（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：257（近 12 个月 139 个）

## 中文简介

OpenAPI 规格 TypeScript type for Freacher - 一个现代,超轻量级的HTTP客户端,用于浏览器和节点.js. 为OpenAPI 3.x schemas提供完整的TypeScript支持并进行类型推论.

## 安装

```sh
npm install @ahoo-wang/fetcher-openapi
```

也可以使用：`pnpm add @ahoo-wang/fetcher-openapi`、`yarn add @ahoo-wang/fetcher-openapi`、`bun add @ahoo-wang/fetcher-openapi`

## README

# `@ahoo-wang/fetcher-openapi`

OpenAPI 3.0 与 3.1 文档的 TypeScript 类型。这是纯类型包：不增加运行时代码，也不解析、校验 或生成客户端。

## 安装

```bash
pnpm add -D @ahoo-wang/fetcher-openapi
```

没有 peer 或运行时依赖。

## 示例

```ts
import type { OpenAPI, Schema } from '@ahoo-wang/fetcher-openapi';

export function documentTitle(document: OpenAPI): string {
  return document.info.title;
}

export const identifier: Schema = {
  type: 'string',
  format: 'uuid',
};
```

## 核心能力

-   根文档（含 3.1 webhooks）、信息、服务器、路径与操作类型。
-   参数、请求体、响应、媒体类型与请求头。
-   Components、引用、Schema、Discriminator 与 XML 元数据。
-   安全方案、OAuth flows、Tags 与 `x-*` 扩展。

把不可信文档作为类型化 OpenAPI 数据前，必须先完成运行时校验。

## 文档

-   [生成客户端](https://fetcher.ahoo.me/zh/guides/services/generated-client)
-   [OpenAPI 参考](https://fetcher.ahoo.me/zh/reference/openapi)

[English](https://npmcn.com/package/%40ahoo-wang/fetcher-openapi/README.md) · [许可证](https://npmcn.com/package/LICENSE)

## 常见问题

### @ahoo-wang/fetcher-openapi 是什么？

OpenAPI 规格 TypeScript type for Freacher - 一个现代,超轻量级的HTTP客户端,用于浏览器和节点\.js\. 为OpenAPI 3\.x schemas提供完整的TypeScript支持并进行类型推论\.

### 如何安装 @ahoo-wang/fetcher-openapi？

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

### @ahoo-wang/fetcher-openapi 支持 TypeScript 吗？

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

### @ahoo-wang/fetcher-openapi 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @ahoo-wang/fetcher-openapi 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.20\.8。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @ahoo-wang/fetcher-openapi 可以商用吗？

@ahoo-wang/fetcher-openapi 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @ahoo-wang/fetcher-openapi 的下载量有多少？

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

### @ahoo-wang/fetcher-openapi 还在维护吗？

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