Ama OpenAPI 创建
[尖叫声] 实验:此包可提前访问,最终版本将发布于v15.
@ ama- openapi/ 创建 是一个模板生成器软件包,为创建基于OpenAPI的项目提供脚手架和模板. 它能帮助开发者迅速建立具有最佳做法和标准化结构的新的OpenAPI项目.
使用量
npm create @ama-openapi -- [options]
以下全局选项可用任何命令 :
| 选项 | 说明 |
|---|---|
--version, (中文(简体) ), -v | 显示当前版本的生成器 . |
--help, (中文(简体) ), -h | 显示 CLI 命令的使用 . |
生成 Open Api 基本工程
创建新 打开API 基本工程通过下列命令:
npm create @ama-openapi <project-name> -- [options]
有以下备选方案:
| 选项 | 默认值 | 说明 |
|---|---|---|
--target, (中文(简体) ), -t | . | 生成文件的目标目录 . |
该命令将生成一个目录,其结构如下:
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(中文(简体) )
一体化
该生成器设置了寄存器, 以便与 :
- @ ama- openapi/ 核心: 核心依赖管理功能
- @ama-openapi/ redocly-plugin (英语): Redocly CLI一体化
- @ama-openapi/ cli (英语): 命令手动取回依赖关系