# @ama-openapi/create 中文文档

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

版本：15\.2\.4
npm 元数据更新时间：2026-11-05T10:49:07.760Z
中文译文更新时间：2026-11-06T10:46:42.611Z
软件包许可：BSD-3-Clause

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

原始 npm 页面：https://www.npmjs.com/package/%40ama-openapi/create
原文对照：https://npmcn.com/package/%40ama-openapi/create/?lang=original
项目主页：https://amadeusitgroup.github.io/otter/
源码仓库：https://github.com/AmadeusITGroup/otter

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

- 包体积（解压后）：21.5 kB，22 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：^22\.22\.3 \|\| ^24\.15\.0 \|\| ^26\.0\.0
- 运行依赖：6 个
- peer 依赖：type-fest ^5\.3\.1
- 首次发布：2025-11-01T02:21:57.319Z
- 最新版本发布：2026-11-05T10:49:07.432Z
- 近 30 天下载量：3426（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：501（近 12 个月 493 个）

## 中文简介

创建新的 OpenApi 规格项目

## 安装

```sh
npm install @ama-openapi/create
```

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

## README

# Ama OpenAPI 创建

> \[尖叫声\] [实验](https://github.com/AmadeusITGroup/otter/blob/main/README.md#experimental):此包可提前访问,最终版本将发布于v15.

[![Stable Version](https://img.shields.io/npm/v/@ama-openapi/create?style=for-the-badge)](https://www.npmjs.com/package/@ama-openapi/create) [![Bundle Size](https://img.shields.io/bundlephobia/min/@ama-openapi/create?color=green&style=for-the-badge)](https://www.npmjs.com/package/@ama-openapi/create)

**@ ama- openapi/ 创建** 是一个模板生成器软件包,为创建基于OpenAPI的项目提供脚手架和模板. 它能帮助开发者迅速建立具有最佳做法和标准化结构的新的OpenAPI项目.

## 使用量

```shell
npm create @ama-openapi -- [options]
```

以下全局选项可用任何命令 :

| 选项 | 说明 |
| --- | --- |
| `--version`, (中文(简体) ), `-v` | 显示当前版本的生成器 . |
| `--help`, (中文(简体) ), `-h` | 显示 CLI 命令的使用 . |

## 生成 Open Api 基本工程

创建新 [打开API](https://www.openapis.org/) 基本工程通过下列命令:

```shell
npm create @ama-openapi <project-name> -- [options]
```

有以下备选方案:

| 选项 | 默认值 | 说明 |
| --- | --- | --- |
| `--target`, (中文(简体) ), `-t` | `.` | 生成文件的目标目录 . |

该命令将生成一个目录,其结构如下:

```text
my-openapi-project/
├── .vscode/
│   ├── extensions.json
│   └── settings.json
├── apis/
│   └── example.v1.yaml
├── models/
│   └── exampleModel.v1.yaml
├── responses/
│   └── exampleResponse.v1.yaml
├── .gitignore
├── openapi.manifest.yaml
├── package.json
├── redocly.yaml
├── README.md
└── renovate.json
```

> \[注\] 软件包包括几个在项目生成期间定制的模板文件:
> 
> -   **API 规格**: 示例 OpenAPI YAML 文件
> -   **配置文件**: 项目具体配置
> -   **发展环境**: VS 代码设置和扩展
> -   **软件包管理**: 预配置 `package.json` 带有常见脚本的文件
> -   **翻新配置**: 扩展 \[@ama-openapi/core preset\] 软件包 ([https://github.com/AmadeusITGroup/otter/tree/main/packages/@ama-openapi/core/renovate/default.json 互联网档案馆的存檔,存档日期2013-12-21](https://github.com/AmadeusITGroup/otter/tree/main/packages/@ama-openapi/core/renovate/default.json)(中文(简体) )

## 一体化

该生成器设置了寄存器, 以便与 :

-   [@ ama- openapi/ 核心](https://www.npmjs.com/package/@ama-openapi/core): 核心依赖管理功能
-   [@ama-openapi/ redocly-plugin (英语)](https://www.npmjs.com/package/@ama-openapi/redocly-plugin): Redocly CLI一体化
-   [@ama-openapi/ cli (英语)](https://www.npmjs.com/package/@ama-openapi/cli): 命令手动取回依赖关系

## 常见问题

### @ama-openapi/create 是什么？

创建新的 OpenApi 规格项目

### 如何安装 @ama-openapi/create？

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

### @ama-openapi/create 支持 TypeScript 吗？

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

### @ama-openapi/create 支持 ESM 还是 CommonJS？

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

### @ama-openapi/create 需要什么版本的 Node\.js？

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

### @ama-openapi/create 可以商用吗？

@ama-openapi/create 使用 BSD-3-Clause 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括，不构成法律意见，请以许可原文为准。

### @ama-openapi/create 的下载量有多少？

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

### @ama-openapi/create 还在维护吗？

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