# @devexperts/swagger-codegen-ts 中文文档

规范地址：https://npmcn.com/package/%40devexperts/swagger-codegen-ts/

版本：2\.0\.0-alpha\.29
npm 元数据更新时间：2023-08-16T09:37:59.728Z
中文译文更新时间：2026-11-12T03:01:52.571Z
软件包许可：MPL-2\.0

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

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

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

- 包体积（解压后）：539 kB，441 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：11 个
- peer 依赖：fp-ts ^2\.1\.0，io-ts ^2\.0\.5，io-ts-types ^0\.5\.1
- 首次发布：2018-10-31T10:35:55.562Z
- 最新版本发布：2023-02-17T12:25:47.746Z
- 近 30 天下载量：13231（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：52（近 12 个月 0 个）

## 中文简介

Swagger 光谱的 TS 生成器

## 安装

```sh
npm install @devexperts/swagger-codegen-ts
```

也可以使用：`pnpm add @devexperts/swagger-codegen-ts`、`yarn add @devexperts/swagger-codegen-ts`、`bun add @devexperts/swagger-codegen-ts`

## README

[![Build Status](https://travis-ci.org/devexperts/swagger-codegen-ts.svg?branch=master)](https://travis-ci.org/devexperts/swagger-codegen-ts)

# TypeScript 的类型安全 OpenAPI 生成器

## 特征

-   生成客户端代码 **OpenAPI 3.0, 2** (阿卡·斯瓦格)和 **AsyncAPI 软件** 规格
-   **可插件的 HTTP 客户端 :** 可使用 `fetch`, (中文(简体) ), `Axios` 或任何其他图书馆
-   **灵活反应类型:** 与承诺和RxJS等反应流合作
-   **运行时间类型检查 :** 验证服务器对光谱的反应
-   写入 **纯类型脚本** 使用 [`fp-ts`](https://github.com/gcanti/fp-ts) 财务报告和审定财务报表 [`io-ts`](https://github.com/gcanti/io-ts) 图书馆

## 演示码

> 以下例子涉及: [Pet Store OpenAPI 3.0 计划](https://petstore3.swagger.io/)。 。 。 .

运行代码源后,与 REST API 的交互可能和这个一样简单:

```typescript
import { petController as createPetController } from "./src/generated/petstore.json/paths/PetController";
import { Pet } from "./src/generated/petstore.json/components/schemas/Pet";

// Creating a controller, see the "HTTP Clients" wiki page for more details
const petController = createPetController({ httpClient: fetchHttpClient });

// The returned object is guaranteed to be a valid `Pet`
const createdPet: Promise<Pet> = petController.addPet({
  body: {
    // The parameters are statically typed, IntelliSense works, too
    name: "Spotty",
    photoUrls: [],
  },
});
```

支持更多的使用方案 - 检查 [使用页面](https://npmcn.com/package/%40devexperts/swagger-codegen-ts/docs/usage/generated-code.md) 更详细.

## 安装

1.  确保安装对等依赖, 然后安装编码源本身 :
    
    ```
    yarn add typescript fp-ts io-ts io-ts-types
    yarn add -D @devexperts/swagger-codegen-ts
    ```
    
2.  创建可引用 `generate` 函数,将路径等选项传递到 schema 文件及输出目录. 见 [发电机](https://npmcn.com/package/%40devexperts/swagger-codegen-ts/docs/usage/api.md) aPI 参考页面,以及 [实例/遗传](https://npmcn.com/package/%40devexperts/swagger-codegen-ts/examples/generate) 用于样本脚本.
    
3.  在大多数情况下,你可能想要将代码生成步骤包含在构建和本地发射脚本中. 示例
    
    ```diff
    /* package.json */
    
      "scripts": {
    +   "generate:api": "ts-node scripts/generate-api.ts",
    -   "start": "react-scripts start",
    +   "start": "yarn generate:api && react-scripts start",
    -   "build": "react-scripts build"
    +   "build": "yarn generate:api && react-scripts build"
      }
    ```
    

## 捐款

-   请随意在其中提交错误和特性请求 [GitHub 问题](https://github.com/devexperts/swagger-codegen-ts/issues/new)。 。 。 .
-   欢迎拉动请求 - 请使用 [常规武器委员会](https://www.conventionalcommits.org/en/v1.0.0-beta.2/)。 。 。 .

请读一下 [贡献者指南](https://npmcn.com/package/%40devexperts/swagger-codegen-ts/docs/development/contributors-guide.md) 更多信息.

## 常见问题

### @devexperts/swagger-codegen-ts 是什么？

Swagger 光谱的 TS 生成器

### 如何安装 @devexperts/swagger-codegen-ts？

在项目目录运行 npm install @devexperts/swagger-codegen-ts，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：fp-ts（^2\.1\.0）、io-ts（^2\.0\.5）、io-ts-types（^0\.5\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @devexperts/swagger-codegen-ts 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/devexperts\_\_swagger-codegen-ts 是否存在。

### @devexperts/swagger-codegen-ts 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @devexperts/swagger-codegen-ts 可以商用吗？

@devexperts/swagger-codegen-ts 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @devexperts/swagger-codegen-ts 的下载量有多少？

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

### @devexperts/swagger-codegen-ts 还在维护吗？

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