jeanberu/swagger-cli

Swagger/OpenAPI CLI镜像

用于https://github.com/APIDevTools/swagger-cli%E7%9A%84Docker%E9%95%9C%E5%83%8F%E3%80%82%E8%AF%A5%E5%B7%A5%E5%85%B7%E6%8F%90%E4%BE%9BSwagger/OpenAPI%E6%96%87%E4%BB%B6%E7%9A%84%E9%AA%8C%E8%AF%81%E5%92%8C%E5%90%88%E5%B9%B6%E5%8A%9F%E8%83%BD%EF%BC%8C%E5%B8%AE%E5%8A%A9%E5%BC%80%E5%8F%91%E8%80%85%E7%A1%AE%E4%BF%9DAPI%E8%A7%84%E8%8C%83%E7%9A%84%E6%AD%A3%E7%A1%AE%E6%80%A7%E5%B9%B6%E7%AE%80%E5%8C%96%E6%96%87%E4%BB%B6%E7%AE%A1%E7%90%86%E3%80%82

核心功能与特性

• 规范验证：检查Swagger/OpenAPI文件是否符合官方规范，识别格式错误和语法问题
• 文件合并：将多个引用外部文件的Swagger文档整合为单个文件，便于分发、部署和文档生成

使用场景与适用范围

• 开发环境中验证API规范文件的正确性
• CI/CD流程中集成Swagger文件验证步骤，确保提交的API规范符合标准
• 需要将分散的Swagger组件文件合并为完整文档的场景

使用方法与配置说明

查看帮助信息

获取Swagger CLI的完整命令说明：

shell
docker run --rm jeanberu/swagger-cli

验证Swagger文件

验证远程URL文件

通过URL验证网络上的Swagger文件：

shell
docker run --rm jeanberu/swagger-cli swagger-cli validate YOUR_URL

验证本地文件

需将本地文件挂载到容器中进行验证。示例：验证当前目录下的YOUR_FILE.yaml文件

shell
docker run --rm -v $PWD/YOUR_FILE.yaml:/swagger.yaml jeanberu/swagger-cli swagger-cli validate swagger.yaml

更多帮助

有关Swagger CLI的详细使用方法和高级功能，请参考https://github.com/APIDevTools/swagger-cli%E3%80%82