README

简介

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 文件夹的内容复制到您的服务器。

兼容性

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

文档

使用

• 安装
• 配置
• CORS
• OAuth2
• 深度链接
• 限制
• 版本检测

自定义

• 概述
• 插件 API
• 自定义布局

开发

• 设置
• 脚本

贡献

• 贡献

集成测试

您需要根据以下说明安装 JDK 7 或更高版本 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（翻译）未实现。
• 外部文件相对路径支持未实现。

安全联系方式

请通过电子邮件向

许可证

SwaggerUI遵循Apache 2.0许可证。SwaggerUI附带一个包含额外法律通知和信息的明确NOTICE文件。