swaggerapi/swagger-ui

Swagger UI Docker镜像文档

概述

Swagger UI是一款允许开发团队及终端用户可视化和交互API资源的工具，无需了解底层实现逻辑。该Docker镜像提供预构建环境，基于OpenAPI（原Swagger）规范自动生成可视化文档，简化API的后端实现与客户端消费流程。

核心功能与特性

• API可视化：直观展示API资源结构与详情，自动生成交互式文档
• 实时交互：支持直接在界面中测试API端点，验证请求与响应
• 规范驱动：基于OpenAPI规范自动构建，减少手动文档维护成本
• 零依赖部署：无需预先部署API实现逻辑即可使用
• 跨团队协作：促进前后端开发、测试及终端用户间的API文档共享

使用场景

• API开发团队快速生成和托管API文档
• 前后端协作时提供清晰的接口规范说明
• API测试与调试过程中的实时交互验证
• 向第三方合作伙伴展示API功能与使用方法

快速部署指南

拉取镜像

从官方仓库拉取预构建的Swagger UI Docker镜像：

sh
docker pull docker.swagger.io/swaggerapi/swagger-ui

启动容器

运行以下命令启动容器，将本地80端口映射到容器的8080端口：

sh
docker run -p 80:8080 docker.swagger.io/swaggerapi/swagger-ui

容器启动后，Swagger UI将通过nginx服务在http://localhost:80地址可用。

版本兼容性

Swagger UI与OpenAPI规范的兼容性如下表所示：

扩展文档与资源

使用指南（英文）

• https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/installation.md
• https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/configuration.md
• https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/cors.md
• https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/oauth2.md
• https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/deep-linking.md
• https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/limitations.md

自定义开发（英文）

• https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/customization/overview.md
• https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/customization/plugin-api.md
• https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/customization/custom-layout.md

浏览器支持

兼容最新版本的Chrome、Safari、Firefox和Edge浏览器。

安全联系

如发现安全漏洞，请发送邮件至***，而非公共issue追踪器。

许可证

采用https://github.com/swagger-api/swagger-ui/blob/HEAD/LICENSE%EF%BC%8C%E9%99%84%E5%B8%A6https://github.com/swagger-api/swagger-ui/blob/HEAD/NOTICE%E5%8C%85%E5%90%AB%E9%A2%9D%E5%A4%96***%E5%A3%B0%E6%98%8E%E3%80%82