manchenkoff/swagger-routes-validator

Swagger Routes Validator

镜像概述

Swagger Routes Validator是一款专门的辅助工具，用于验证API路由是否被Swagger文档完整覆盖，帮助开发者确保API文档与实际路由的一致性，提升API文档的准确性。

核心功能

• 检查API路由与Swagger文档的覆盖情况
• 支持多路由文件配置
• 允许为路由文件设置前缀

使用场景

适用于API开发过程中，开发者需要验证Swagger文档是否完整覆盖所有API路由，避免文档缺失或与实际路由不一致的场景。

配置说明

通过配置文件指定Swagger文档路径和路由文件信息，配置示例如下：

yaml
swagger: /var/data/example/swagger-doc/swagger.yml

routes:
  default:
    path: /var/data/example/routing/v1.yml
  with_prefix:
    path: /var/data/example/routing/v2.yml
    prefix: /v2

环境变量：

• CONFIG: 配置文件的路径

部署示例

使用Docker运行镜像：

bash
$ docker run -i \
    -v $(PWD)/data:/var/data \
    -e CONFIG=/var/data/config.yml \
    --name swagger-routes-validator --rm \
    manchenkoff/swagger-routes-validator:latest

将本地data目录挂载到容器的/var/data目录，并通过CONFIG环境变量指定配置文件路径。 ===FULL_DESC===