swagger-ui

swagger-ui

开源API文档可视化与交互工具

Swagger UI是一款开源的API文档生成工具,能够自动根据OpenAPI规范创建可视化文档。开发团队和用户可以直观地浏览和测试API资源,无需编写代码。该工具兼容多个OpenAPI版本,具有丰富的配置和自定义选项,适用于各类项目。Swagger UI提供多种集成方式,包括npm模块和React组件,便于在不同应用中使用。它简化了API文档的创建和维护过程,提高了开发效率。

Swagger UIAPI文档OpenAPI可视化开源项目Github

<img src="https://yellow-cdn.veclightyear.com/0a4dffa0/34ba10f7-808f-4aa0-bad0-97d33832ce9c.png" width="300">

NPM 版本 构建状态 npm 审计 GitHub 贡献者总数

每月 npm 安装量 docker 拉取总数 每月 packagist 安装量 gzip 大小

简介

Swagger UI 允许任何人——无论是您的开发团队还是最终用户——在没有任何实现逻辑的情况下,直观地查看和交互 API 的资源。它根据您的 OpenAPI(前身为 Swagger)规范自动生成,通过可视化文档使后端实现和客户端使用变得简单。

概述

👉🏼 想轻松为开源项目做贡献? 查看我们的 适合新手的问题 标签。

🕰️ 在寻找旧版本的 Swagger UI? 请参考 2.x 分支

本仓库发布了三个不同的 NPM 模块:

  • swagger-ui 是一个传统的 npm 模块,适用于能够解析依赖关系(通过 Webpack、Browserify 等)的单页应用程序。
  • swagger-ui-dist 是一个无依赖的模块,包含了在服务器端项目或无法解析 npm 模块依赖的单页应用程序中提供 Swagger UI 所需的一切。
  • swagger-ui-react 是打包为 React 组件的 Swagger UI,用于 React 应用程序。

如果您正在构建单页应用程序,我们强烈建议您使用 swagger-ui 而不是 swagger-ui-dist,因为 swagger-ui-dist 明显更大。

如果您需要纯 HTML/JS/CSS,请下载最新版本并将 /dist 文件夹的内容复制到您的服务器。

兼容性

OpenAPI 规范自 2010 年创建以来经历了 5 次修订。Swagger UI 与 OpenAPI 规范的兼容性如下:

Swagger UI 版本发布日期OpenAPI 规范兼容性备注
5.0.02023-06-122.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0标签 v5.0.0
4.0.02021-11-032.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3标签 v4.0.0
3.18.32018-08-032.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3标签 v3.18.3
3.0.212017-07-262.0标签 v3.0.21
2.2.102017-01-041.1, 1.2, 2.0标签 v2.2.10
2.1.52016-07-201.1, 1.2, 2.0标签 v2.1.5
2.0.242014-09-121.1, 1.2标签 v2.0.24
1.0.132013-03-081.1, 1.2标签 v1.0.13
1.0.12011-10-111.0, 1.1标签 v1.0.1

文档

使用

定制

开发

贡献

集成测试

您需要 7 或更高版本的 JDK,如这里所述 https://nightwatchjs.org/guide/getting-started/installation.html#install-selenium-server

可以使用 npm run e2e 在本地运行集成测试 - 请确保在测试时没有运行开发服务器!

浏览器支持

Swagger UI 适用于 Chrome、Safari、Firefox 和 Edge 的最新版本。

已知问题

为了帮助迁移,以下是 3.X 版本目前已知的问题。此列表将定期更新,不包括以前版本中未实现的功能。

  • 仅支持部分先前支持的参数。
  • 未实现 JSON 表单编辑器。
  • collectionFormat 的支持是部分的。
  • 未实现 l10n(翻译)。
  • 未实现外部文件的相对路径支持。

安全联系

请通过电子邮件 security@swagger.io 披露任何与安全相关的问题或漏洞,而不是使用公共问题跟踪器。

许可证

SwaggerUI 采用 Apache 2.0 许可证授权。 SwaggerUI 附带一个明确的 NOTICE 文件,其中包含额外的法律声明和信息。

编辑推荐精选

TRAE编程

TRAE编程

AI辅助编程,代码自动修复

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多