swagger ui

介绍

Swagger UI允许任何人 - 无论是您的开发团队还是您的最终消费者 - 都可以在没有任何实施逻辑的情况下与API资源进行可视化和互动。它是由您的OpenAPI（以前称为Swagger）规范生成的，其视觉文档使后端实现和客户端消耗变得易于使用。

一般的

？想要为简单的开源贡献获得评分吗？查看我们良好的第一期标签。

？寻找较旧版本的Swagger UI？请参阅2.x分支。

该存储库发布了三个不同的NPM模块：

• Swagger-UI是一个传统的NPM模块，旨在用于能够解决依赖关系的单页应用程序（通过WebPack，browserify等）。
• Swagger-UI-DIST是一个无依赖项的模块，其中包括您在服务器端项目中提供Swagger UI的所有内容，或者无法解析NPM模块依赖项的单页应用程序。
• Swagger-UI反应被用作反应应用中的反应组件。

我们强烈建议您使用swagger-ui而不是swagger-ui-dist如果您要构建单页应用程序，因为swagger-ui-dist大得多。

如果您正在寻找普通的OL'HTML/JS/CSS，请下载最新版本，然后将/dist文件夹的内容复制到服务器。

兼容性

自2010年最初创建以来，OpenAPI规范已进行了5个修订。SwaggerUI和OpenAPI规范之间的兼容性如下：

Swagger UI版本	发布日期	OpenAPI规格兼容性	笔记
5.0.0	2023-06-12	2.0、3.0.0、3.0.1、3.0.2、3.0.3、3.1.0	标签v5.0.0
4.0.0	2021-11-03	2.0、3.0.0、3.0.1、3.0.2、3.0.3	标签v4.0.0
3.18.3	2018-08-03	2.0、3.0.0、3.0.1、3.0.2、3.0.3	标签v3.18.3
3.0.21	2017-07-26	2.0	标签v3.0.21
2.2.10	2017-01-04	1.1、1.2、2.0	标签v2.2.10
2.1.5	2016-07-20	1.1、1.2、2.0	标签v2.1.5
2.0.24	2014-09-12	1.1，1.2	标签v2.0.24
1.0.13	2013-03-08	1.1，1.2	标签v1.0.13
1.0.1	2011-10-11	1.0，1.1	标签v1.0.1

匿名分析

Swaggerui使用围巾收集匿名安装分析。这些分析有助于支持该库的维护者，并且仅在安装过程中运行。要选择退出，您可以将scarfSettings.enabled已启用字段设置为项目package.json中的false ：

 // package.json
{
  // ...
  "scarfSettings": {
    "enabled": false
  }
  // ...
}

另外，您可以将环境变量SCARF_ANALYTICS设置为false ，作为安装NPM软件包的环境的一部分，例如， SCARF_ANALYTICS=false npm install 。

文档

用法

• 安装
• 配置
• 科尔斯
• OAuth2
• 深连接
• 限制
• 版本检测

定制

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

发展

• 设置
• 脚本

贡献

• 贡献

集成测试

您将需要在此处指示的第7版或更高版本的JDK

集成测试可以使用npm run e2e在本地运行 - 确保在测试时不会运行Dev Server！

浏览器支持

Swagger UI在Chrome，Safari，Firefox和Edge的最新版本中工作。

已知问题

为了帮助迁移，以下是3.x的当前已知问题。此列表将定期更新，并且不会包含以前版本中未实现的功能。

• 以前仅支持的参数的一部分可用。
• JSON表单编辑器未实施。
• 支持collectionFormat是部分的。
• L10N（翻译）未实施。
• 未实现对外部文件的相对路径支持。

安全联系

请通过电子邮件[email protected]来披露与安全有关的问题或漏洞，而不是使用公共问题跟踪器。

执照

Swaggerui已获得Apache 2.0许可证的许可。 Swaggerui带有一个明确的通知文件，其中包含其他法律通知和信息。