# @azure-tools/spec-gen-sdk 中文文档

规范地址：https://npmcn.com/package/%40azure-tools/spec-gen-sdk/

版本：0\.9\.11
npm 元数据更新时间：2026-11-06T23:23:36.028Z
中文译文更新时间：2026-11-07T14:02:07.155Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40azure-tools/spec-gen-sdk
原文对照：https://npmcn.com/package/%40azure-tools/spec-gen-sdk/?lang=original
项目主页：https://github.com/Azure/azure-sdk-tools
源码仓库：https://github.com/Azure/azure-sdk-tools

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

- 包体积（解压后）：640 kB，203 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.13\.0
- 运行依赖：11 个
- 首次发布：2024-12-19T00:08:19.248Z
- 最新版本发布：2026-11-06T23:23:35.864Z
- 近 30 天下载量：37204（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：44（近 12 个月 9 个）

## 中文简介

将 API 规格执行到 SDK 工具

## 安装

```sh
npm install @azure-tools/spec-gen-sdk
```

也可以使用：`pnpm add @azure-tools/spec-gen-sdk`、`yarn add @azure-tools/spec-gen-sdk`、`bun add @azure-tools/spec-gen-sdk`

## README

# Spec-gen-sdk (英语)

Spec-gen-sdk从本地规格存储器中协调 SDK 生成 本地 SDK 仓库, 引用 SDK 中配置的语言自动化 存储器 `swagger_to_sdk_config.json`。 。 。 .

## 生成输入合同

配置 `generateScript` 接收路径到 `generateInput.json` 财务报告和审定财务报表 `generateOutput.json`。输入合同由 [`GenerateInputSchema.json`](https://github.com/Azure/azure-sdk-tools/blob/main/tools/spec-gen-sdk/src/types/GenerateInputSchema.json)。 。 。 .

呼叫者可以选择通过 `--typespec-emitter <package-name>` 给spec -gen -sdk. 数值以不变方式在 `generateInput.json` 作为 `typespecEmitter`数字 :

```json
{
  "typespecEmitter": "@azure-tools/typespec-ts-provisioning"
}
```

这是摘录,不是完整的生成输入 。 软件包名称就是一个例子; 没有默认的发射器。 当选项被省略时, 序列化输入 省略 `typespecEmitter`,保留现有的语言自动化行为. 程序调用器可以在 `SdkAutoOptions`。 。 。 .

当选择了非空发射器时, spec-gen-sdk 要求该发射器拥有 启用( 真实) 条目 `options` (或遗产) `emitters` 何时 `options` 实值 (缺席) `tspconfig.yaml` 并映射到所请求的 SDK 仓库 规格仓库配置。 否则它会记录一个配置 警告和返回 `notEnabled` 而不引用语言自动化。 一个 需要明确发送请求 `tspConfigPath` 并且不会回到 通过 OpenAPI 生成 `readmePath`。输出或空的发射选择 保存现有的寄存器级启用和倒置行为.

字段不安装发送器或修改 `tspconfig.yaml`语言 自动化必须支持现场使用;提供管道配置 和语言特定生成支持是独立的更改.

## 发展

使用Node.js 22.13.0或后期. 从此目录中运行 `npm ci` 要安装 依附关系, `npx tsc --noEmit` 键入检查, `npm run lint` 用于涂料,以及 `npm test` 进行测试.

## 常见问题

### @azure-tools/spec-gen-sdk 是什么？

将 API 规格执行到 SDK 工具

### 如何安装 @azure-tools/spec-gen-sdk？

在项目目录运行 npm install @azure-tools/spec-gen-sdk，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 spec-gen-sdk，可以用 npx spec-gen-sdk 直接运行。

### @azure-tools/spec-gen-sdk 支持 TypeScript 吗？

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

### @azure-tools/spec-gen-sdk 支持 ESM 还是 CommonJS？

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

### @azure-tools/spec-gen-sdk 需要什么版本的 Node\.js？

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

### @azure-tools/spec-gen-sdk 可以商用吗？

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

### @azure-tools/spec-gen-sdk 的下载量有多少？

根据 npm 官方下载统计，@azure-tools/spec-gen-sdk 在 2026/10/08 – 2026/11/06 这 30 天内被下载 37,204 次，日均约 1,240 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @azure-tools/spec-gen-sdk 还在维护吗？

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