# @autorest/openapi-to-typespec 中文文档

规范地址：https://npmcn.com/package/%40autorest/openapi-to-typespec/

版本：0\.11\.14
npm 元数据更新时间：2026-04-09T15:25:10.427Z
中文译文更新时间：2026-11-07T07:07:31.928Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：904 kB，318 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：9 个
- 首次发布：2023-12-22T03:19:10.832Z
- 最新版本发布：2026-04-09T15:25:10.247Z
- 近 30 天下载量：40276（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：110（近 12 个月 4 个）

## 中文简介

从 OpenAPI 文档中获取类型定义的脚手架自动调取插件

## 安装

```sh
npm install @autorest/openapi-to-typespec
```

也可以使用：`pnpm add @autorest/openapi-to-typespec`、`yarn add @autorest/openapi-to-typespec`、`bun add @autorest/openapi-to-typespec`

## README

## 自动刷新开口到类型区块插件

从现有的 OpenApi 文档中自动复制到脚手架的新类型Spec 定义 .

运行它

```bash
autorest --openapi-to-typespec --input-file=<path-to-swagger> --namespace=<namespace> --title="<ProjectName>" --use=@autorest/openapi-to-typespec@next --output-folder=.
```

或带有 README 配置文件

```bash
autorest --openapi-to-typespec --require=<path-to-readme-config>.md --use=@autorest/openapi-to-typespec@next --output-folder=.
```

此插件将生成以下文件

主. tsp - TypeSpec 项目的入站点, 它包含服务信息 model.tsp - 包含所有模型定义 routes.tsp - 包含所有资源终点 tsproject.yaml - 包含类型Spec编译器的配置 package.json - TypeSpec 项目的配置

```yaml
version: 3.10.1
use-extension:
  "@autorest/modelerfour": "^4.27.0"

include-x-ms-examples-original-file: true

modelerfour:
  # this runs a pre-namer step to clean up names
  prenamer: false

openapi-to-typespec-scope/emitter:
  input-artifact: openapi-to-typespec-files

output-artifact: openapi-to-typespec-files

pipeline:
  source-swagger-detector:
    input: openapi-document/multi-api/identity
  openapi-to-typespec: # <- name of plugin
    input:
      - modelerfour/identity
      - source-swagger-detector
    output-artifact: openapi-to-typespec-files

  openapi-to-typespec/emitter:
    input: openapi-to-typespec
    scope: openapi-to-typespec-scope/emitter
```

## 常见问题

### @autorest/openapi-to-typespec 是什么？

从 OpenAPI 文档中获取类型定义的脚手架自动调取插件

### 如何安装 @autorest/openapi-to-typespec？

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

### @autorest/openapi-to-typespec 支持 TypeScript 吗？

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

### @autorest/openapi-to-typespec 支持 ESM 还是 CommonJS？

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

### @autorest/openapi-to-typespec 可以商用吗？

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

### @autorest/openapi-to-typespec 的下载量有多少？

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

### @autorest/openapi-to-typespec 还在维护吗？

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