usabillabv/openapi3-validator

OpenAPI v3 验证器

镜像概述和主要用途

这是一个运行openapi-spec-validator（https://github.com/p1c2u/openapi-spec-validator%EF%BC%89%E7%9A%84Docker%E9%95%9C%E5%83%8F%EF%BC%8C%E5%8F%AF%E9%9B%86%E6%88%90%E5%88%B0CI%E6%9C%8D%E5%8A%A1%E5%99%A8%E6%88%96%E5%9C%A8%E5%BC%80%E5%8F%91%E8%BF%87%E7%A8%8B%E4%B8%AD%E4%BD%BF%E7%94%A8%E3%80%82%E5%B0%BD%E7%AE%A1%E4%BB%8D%E5%9C%A8%E6%94%B9%E8%BF%9B%E4%B8%AD%EF%BC%8C%E4%BD%86%E5%AE%83%E5%B7%B2%E8%83%BD%E5%B8%AE%E5%8A%A9%E7%A1%AE%E4%BF%9DAPI%E8%A7%84%E8%8C%83%E5%AE%9E%E9%99%85%E9%81%B5%E5%BE%AAhttps://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md%E3%80%82

核心功能和特性

• 基于开源工具openapi-spec-validator构建，确保API规范符合OpenAPI v3标准
• 支持验证本地文件系统中的API规范文件
• 支持通过HTTP(s)端点验证远程API规范
• 轻量级设计，易于集成到CI/CD流程或开发环境

使用场景和适用范围

• CI/CD流程集成：在代码提交或构建过程中自动验证API规范的合规性
• 开发阶段：在API文档编写过程中即时验证，提前发现规范问题
• 团队协作：确保团队成员编写的API规范统一符合OpenAPI v3标准

使用方法和配置说明

拉取镜像

首先需要从Docker Hub拉取镜像：

sh
docker pull docker.xuanyuan.run/usabillabv/openapi3-validator

验证本地文件

通过共享卷验证本地文件系统中的API规范：

sh
docker run -it --rm -v $(pwd):/project -w /project docker.xuanyuan.run/usabillabv/openapi3-validator <文件路径>

验证远程文件

通过HTTP(s)端点验证远程API规范：

sh
docker run -it --rm docker.xuanyuan.run/usabillabv/openapi3-validator <URI>

创建别名（可选）

可创建别名以便简化使用：

sh
alias openapi3-validate='docker run -it --rm -v $(pwd):/project -w /project usabillabv/openapi3-validator'
openapi3-validate <文件路径或URI>