使用 swagger-cli 将多文件 OpenAPI 定义打包并验证为可发布的规范 是做什么的?
在文档生成、代码生成或 CI 关卡依赖规范之前,将多文件 OpenAPI 定义解析为单一经过验证的产物。
前提条件
Node.js、npm 或 npx,以及一个或多个包含本地或远程 $ref 目标的 Swagger/OpenAPI JSON 或 YAML 文件(根据需要)。
安装
使用与您环境匹配的上游安装或设置路径:
- npm install -g @apidevtools/swagger-cli
- git clone https://github.com/APIDevTools/swagger-cli.git
- npm install
- npm test
上游的要求和注意事项:
- 有一个名为 pre-commit 的实用 Python 工具,可用于执行广泛的预提交检查。swagger-cli validate 命令可以作为 Git pre-commit 钩子的一部分集成…
基本用法或入门说明:
-
bash
-
swagger-cli <命令> [选项] <文件>
-
摘自上游文档:https://raw.githubusercontent.com/APIDevTools/swagger-cli/HEAD/README.md