我们想快速分享一下 Swagger OSS 团队一直在做的工作,包括我们感到兴奋的最新增强功能
SwaggerUI v4 和 SwaggerEditor v4 的新特性
升级到 v4 将使我们能够进一步 发展 SwaggerUI/SwaggerEditor,以使用 React 的最新功能(Hooks、Contexts 等...),并为 OpenApi 3.1 的采用做准备。
SwaggerUI v3 和 SwaggerEditor v3 目前都在运行 React@15 的旧版本分支,该版本最后一次更新是在 9 个月前。Redux 也存在同样的情况,我们被绑定在一个旧版本上。通过 v4 发布,我们可以将这些库更新到最新版本
- react 15.7.0 -> 17.0.2
- react-dom 15.7.0 -> 17.0.2
- redux 3.7.2 -> 4.1.0
- react-redux 4.4.10 -> 7.2.4
我们认为此次发布是一个破坏性变更,因为我们将停止对任何旧版本 React 和 Redux 的支持。此次变更的影响将主要由将 SwaggerUI/SwaggerEditor 作为库使用、并用它来渲染现有代码的组织感受到。在某些情况下,您可能还有其他以这种方式与 SwaggerUI/SwaggerEditor 集成的库。
在这两种情况下,现有代码必须与 SwaggerUI/SwaggerEditor 运行相同版本的 React。使用 v4 意味着要么更新所有与现有代码一起使用的 React 代码(以便使其在 React@17 中运行),要么使用不同版本的 React 运行 v4。这称为渐进式升级,其文档可在此处找到。
如何立即探索 Swagger v4
我们将维护 v4 发布分支,您可以在本地检出并构建自己的工件进行测试
SwaggerUI@v4 的 NPM 包已经可用,SwaggerEditor@v4 NPM 包将于 2021 年 7 月 26 日当周可用。
预计发布时间表
我们预计 v4 Beta 版将于 2021 年 7 月 7 日发布。可能还需要几周时间才能发布首个 v4 RC(发布候选版)。在首个 v4 Beta 版和首个 RC 版之间的时间段内,我们将不会合并任何包含新功能的 PR。我们希望将合并的 PR 限制为错误修复,并且这些错误修复将被回溯到 v4 发布分支。
您可以在以下问题中找到有关 v4 工作、库更新以及我们检测到的异常的更多信息
3.x 分支的生命周期
在稳定的 v4.0.0 版本发布后,我们将继续支持 3.x 分支至少 4-6 周的维护期。在 3.x 维护期内,我们将自动将安全和/或错误修复回溯到 3.x 分支,并发布 v3 补丁版本。