Swagger Doc View
🔗 GitHub: github.com/mmm11111/sw…
🐳 Docker Hub: mmmm11111/swagger-doc-view
Swagger Doc View 是一款轻量、现代化的一站式 OpenAPI 文档浏览与调试工具。它旨在解决传统 Swagger UI 界面陈旧、调试不便的问题,为研发、测试和运维团队提供更高效的接口协作体验。
✨ 核心特性
- 一站式浏览与调试:集接口文档展示、复杂 Schema 解析、在线调试于一体,无需在 Swagger UI 和 Postman 之间反复切换。
- 多环境/多源管理:原生支持
swagger-config分组配置,秒级切换不同服务或版本的接口集合。 - 智能示例生成:自动解析
$ref、allOf等复杂结构,生成清晰的 JSON 示例与结构树;支持一键复制 Markdown、cURL、Fetch 代码。 - 极致轻量部署:官方 Docker 镜像,内置 H2 数据库,零外部依赖,单容器即可私有化部署。
- 功能细节打磨:支持 Basic Auth 认证、接口关键词搜索、最近使用记忆、参数自动填充等贴心功能。
🚀 适用场景
- 企业内部协作:作为统一的 API 门户,管理微服务架构下的多个 Swagger 文档。
- 快速排查验证:运维或测试人员无需配置复杂环境,直接在线验证 API 连通性与返回结果。
- 对外演示交付:为产品演示或技术交付提供一个美观、“开箱即用”的接口展示前台。
🛠️ 快速部署
支持 Docker 一键启动,快速拥有私有化接口文档服务。
Docker CLI
docker run -d \
--name swagger-doc-view \
-p 8080:80 \
-v $(pwd)/data:/app/data \
-e SECURITY_BASIC_AUTH_USERNAME=admin \
-e SECURITY_BASIC_AUTH_PASSWORD=admin123 \
mmmm11111/swagger-doc-view:v1.1.2
Docker Compose
version: "3.8"
services:
swagger-doc-view:
image: mmmm11111/swagger-doc-view:v1.1.2
container_name: swagger-doc-view
ports:
- "8080:80"
environment:
TZ: Asia/Shanghai
SECURITY_BASIC_AUTH_USERNAME: admin
SECURITY_BASIC_AUTH_PASSWORD: admin123
volumes:
- ./data:/app/data
restart: unless-stopped
访问 http://localhost:8080/,输入 Swagger 配置地址(如 /v3/api-docs 或 swagger-config URL)即可开始使用。
🤝 反馈与贡献
欢迎通过 GitHub Issues 提交建议或 Bug 反馈,共同完善使用体验!
立即部署 Swagger Doc View,让接口文档转化为可视、可调、高效的协作平台! 🚀