新的 Swagger 编辑器和 Swagger UI

自上次更新以来已经两年了,在听取了数万用户的反馈后,新的 Swagger UI 和 Swagger 编辑器终于问世了!它们将速度和可靠性带到了 API 设计和文档流程的前沿。新版本还引入了可扩展机制,允许用户完全自定义界面并在核心 Swagger 平台之上构建自己的功能。

您可以在各自的 GitHub 存储库中找到这些项目。

Swagger-UI: https://github.com/swagger-api/swagger-ui

Swagger-Editor: https://github.com/swagger-api/swagger-editor

显然,我们预计会有问题,因此我们在下面添加了常见问题解答部分。

常见问题

等等,刚刚发生了什么?

Swagger-UI 于 2011 年首次发布,而 Swagger-Editor 于 2014 年发布。正如你们大多数人所知,这两个项目是独立开发的,基于不同的技术,并且没有提供相同的用户体验。我们最终“合并”了这两个项目,对两者使用了类似的技术基础。作为我们工作的一部分,我们也完全重做了 swagger-js。

所以现在只有一个项目了吗?

嗯,不是的。我们创建了一个新的可插拔系统。Swagger-UI 现在包含该系统的核心,而编辑器只是添加到它的一组插件。我们仍然为您提供一种运行 swagger-editor 作为项目的方法,而无需了解这些插件是如何工作的。

为什么要费这么大劲?

原因有很多

  • 如上所述,技术的合并和向新技术的迁移。这些项目已经过时了,是时候加快速度了。
  • 我们希望为这两个项目提供熟悉的用户界面。
  • 为您提供更多的可定制性。更多得多。
  • 为您提供更多的可扩展性。你猜对了,更多得多。
  • 使我们更容易支持该规范的下一个版本。
  • 提高渲染、验证的性能。
  • 改进编辑器中的验证,使使用者更容易从头开始编写规范。

嘿,UI 怎么了?!我更喜欢 Swagger-X 中的 UI!

我们取了现有项目中最好的部分,加以改进,瞧!我们可能会在未来几周内进行更多更改,当我们支持该规范的下一个版本时肯定会进行更多更改。

但我想要旧的外观和感觉!

这就是新项目的好处——如果你想修改 UI 以满足你的需求,现在容易多了。

它支持该规范的下一个版本吗?

如上所述,此更改的主要原因之一是使我们更容易支持该规范的下一个版本。这是我们待办事项清单上的下一个主要事项。

之前的项目版本中出现的问题呢?还会进一步开发吗?我们可以期望获得多长时间的支持?

考虑到该规范的下一个版本,以及我们为新项目所做的工作,我们不再积极开发之前的版本。我们的努力集中在新版本的项目上。我们将继续支持旧版本几个月,以便让每个人都有足够的时间进行过渡。我们将发布关于正式停止支持的官方公告。在某些情况下,我们仍然会提供旧项目的新版本,具体取决于问题的严重程度。

新项目支持哪些规范版本?

2.0,我们正在努力支持该规范的下一个版本。不再支持旧版本。对于那些仍然使用低于 2.0 版本规范的人,我们建议您花时间研究并升级它。

缺少功能 X!功能 Y 坏了!

哎呀。我们试图尽可能接近功能对等,但我们可能遗漏了一些。通过在项目上提交一个关于缺失功能的工单来帮助我们。

我如何提供帮助?

就像你之前做的那样

  • 有什么东西不起作用?提交工单!
  • 缺少什么东西?提交工单!
  • 您想看到更多内容?提交工单!
  • 有时间解决以上任何问题吗?提交 PR!

就这么简单。