@ama-openapi/ cli (英语)
[尖叫声] 实验:此包可提前访问,最终版本将发布于v15.
一个命令行界面(CLI)工具,通过显示文件管理OpenAPI规格及其依赖性.
说明
这个 @ama-openapi/cli 软件包提供了一个CLI工具,用于自动化安装和管理 OpenAPI 规格 基于 显示文件。 。 。 .
这是其中的一部分 AMA OpenAPI 生态系统 帮助管理您的项目中的 OpenAPI 依赖性.
安装
全球安装
npm install @ama-openapi/cli
[!INFO] 软件包需要安装为
dependency允许 模式共享。 。 。 .
使用量
CLI通过下列途径提供: ama-openapi 命令并提供以下功能:
ama-openapi <command> [options]
以下全局选项可用任何命令 :
| 选项 | 类型 | 默认 | 说明 |
|---|---|---|---|
--log-level, (中文(简体) ), -l | "silent" | "error" | "warning" | "info" | "debug" | error | 定义要在控制台中显示的日志的具体级别 |
--help, (中文(简体) ), -h | 显示帮助信息 |
可用命令
install 命令
此命令扫描用于 显示文件 安装全部 OpenAPI 规格 在这些文件中指明。 安装过程会根据您的运单中的配置下载和处理 OpenAPI 规格 .
ama-openapi install [options]
实例:
# Install dependencies from manifest files
ama-openapi install
# Install with debug output
ama-openapi install --debug
# Install silently
ama-openapi install --silent
watch 命令
此命令启动一个文件监视器, 用于监视显示文件的更改 。 当表单文件被修改时,它会自动触发安装过程,确保您 OpenAPI 规格 在发展过程中始终是最新的.
ama-openapi watch [options]
实例:
# Start watching manifest files
ama-openapi watch
# Watch with debug output
ama-openapi watch --debug
generate-schema 命令
生成 JSON 谢马斯 用于配置自动补全.
npm exec @ama-openapi/cli generate-schema -- [options]
选项
| 选项 | 别名 | 说明 | 默认值 |
|---|---|---|---|
--output | -o | 输出目录以在哪里生成计划 | './schemas' |
--keywords | -k | 用于设计时要考虑的文物的关键词列表 | ['openapi'] |
展示可共享模式
要从OpenAPI软件包中曝光模型,需要以下设置: 1
- 这个
models/(或任何可共享的文件夹)应列在 packet.json 导出 字段. - 这个
models_external/应列在 软件包.json 已曝光 文件夹. - 这个
models_external/包含内容的文件夹必须在已安装的软件包中存在
为确保根据最后规格要求的版本正确解决依赖关系问题,应具备 models_external/ 只能通过 后置进程。 。 。 .
// package.json file
{
"name": "@my/spec",
"scripts": {
"postinstall": "ama-openapi install"
}
}
[注] 查找更多关于模型依赖分辨率的信息 @ama-openapi/ 核心文件。 。 。 .
[TIP] 仓库生成器来自 @ ama- openapi/ 创建 配置软件包,允许模型默认展开.
一体化
这一CLI工具旨在与下列机构无缝地工作:
- @ ama- openapi/ 核心: 核心依赖管理功能
- @ama-openapi/ redocly-plugin (英语) - Redocly CLI一体化
- @ ama- openapi/ 创建 - 项目脚手架工具