搜索yiiisoft / yii2-swagger-ui
yii2 yii2SwaggerUi
Requires
- yiisoft/yii2: ~2.0.0
This package is auto-updated.
Last update: 2024-09-17 20:04:44 UTC
README
👉🏼 想要轻松做出开源贡献吗？ 查看我们的 Good first issue 标签。
🕰️ 想要旧版本的 Swagger UI 吗？ 请参考 2.x 分支。
此存储库发布到三个不同的 NPM 模块
- swagger-ui 是一个传统的 npm 模块，适用于能够解析依赖项的单页应用（通过 Webpack、Browserify 等）。
- swagger-ui-dist 是一个无依赖的模块，包含在服务器端项目中或无法解析 npm 模块依赖的单页应用中提供 Swagger UI 所需的一切。
- swagger-ui-react 是用于 React 应用的包装为 React 组件的 Swagger UI。
如果您正在构建单页应用，我们强烈建议您使用 swagger-ui 而不是 swagger-ui-dist，因为 swagger-ui-dist 的体积要大得多。
兼容性
自 2010 年首次创建以来，OpenAPI 规范已经历 5 次修订。Swagger UI 与 OpenAPI 规范的兼容性如下
文档
用法
定制
开发
集成测试
按照以下说明，您需要 JDK 7 或更高版本：https://nightwatch.node.org.cn/gettingstarted#selenium-server-setup
可以通过 npm run e2e 在本地运行集成测试 - 确保您在测试时没有运行开发服务器！
浏览器支持
Swagger UI 在 Chrome、Safari、Firefox、Edge 和 IE11 的最新版本中都能正常工作。
已知问题
为了帮助迁移，以下是 3.X 版本目前已知的问题。此列表将定期更新，并且不会包括在先前版本中未实现的功能。
- 仅部分支持以前支持的部分参数。
- JSON 表单编辑器尚未实现。
- 对
collectionFormat的支持是部分的。 - l10n（翻译）尚未实现。
- 外部文件相对路径支持尚未实现。
安全联系人
请通过电子邮件 security@swagger.io 披露任何与安全相关的漏洞或问题，而不是使用公共问题跟踪器。
许可
版权 2019 SmartBear Software
根据 Apache License，版本 2.0（“许可证”）许可；除非遵守许可证，否则您不得使用此文件。您可以在 apache.org/licenses/LICENSE-2.0 获取许可证副本。
除非适用法律要求或书面同意，否则在许可证下分发的软件按照“原样”基础分发，不提供任何形式的保证或条件，无论是明示的还是默示的。有关许可证下许可和限制的具体语言，请参阅许可证。