stempler/swagger-ui

Swagger UI 镜像（带JWT支持）

镜像概述

本镜像为支持JWT认证的Swagger UI实现，基于schickling/swagger-ui改编，旨在提供轻量级、易于配置的API文档可视化与交互工具。适用于开发测试环境中API接口的文档展示与调试，支持快速部署与灵活配置。

核心功能与特性

• JWT支持：集成JWT认证机制，满足需要令牌验证的API接口调试需求
• 轻量级设计：镜像体积仅45MB，资源占用低，启动迅速
• 灵活配置：支持通过环境变量注入API_URL（API文档JSON地址）和API_KEY（API访问密钥）
• 版本信息：基于Swagger UI 2.1.2稳定版本构建

使用场景

• 开发环境中API文档的快速部署与展示
• 需要JWT认证的API接口调试与测试
• 前后端开发团队共享API交互文档
• 临时API演示或内部文档服务

使用方法

基本部署（docker run）

bash
docker run -d -p 8080:8080 \
  -e API_URL=http://your-api-server/docs.json \
  -e JWT_TOKEN=your-jwt-token \
  schickling/swagger-ui

访问 http://localhost:8080 即可查看API文档界面。

环境变量配置

Docker Compose配置示例

yaml
version: '3'
services:
  swagger-ui:
    image: schickling/swagger-ui
    container_name: swagger-ui
    ports:
      - "8080:8080"
    environment:
      - API_URL=http://api.example.com/swagger.json
      - JWT_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
    restart: unless-stopped

常见问题（FAQ）

• Q：镜像为何体积较小？
  A：采用精简基础镜像并通过install.sh脚本优化构建流程，仅保留核心功能组件。

• Q：如何更新JWT令牌？
  A：通过重新设置JWT_TOKEN环境变量并重启容器即可应用新令牌。

• Q：是否支持本地API文档文件？
  A：目前主要支持通过API_URL指定远程JSON文件，如需本地文件可结合数据卷挂载实现。