全新的Swagger Editor和Swagger UI
距离上次更新已过去两年,在听取了数万用户的反馈后,全新的Swagger UI和Swagger Editor终于问世了!它们将速度和可靠性带入API设计和文档流程的前沿。新版本还引入了可扩展机制,允许用户完全自定义界面,并在核心Swagger平台之上构建自己的功能。
您可以在它们各自的GitHub仓库中找到这些项目。
Swagger-UI: https://github.com/swagger-api/swagger-ui
Swagger-Editor: https://github.com/swagger-api/swagger-editor
显然,我们预计会收到问题,因此我们在下方添加了常见问题解答(FAQ)部分。
常见问题
等等,发生什么事了?
Swagger-UI于2011年首次发布,Swagger-Editor于2014年发布。正如大多数人所知,这两个项目是独立开发的,基于不同的技术,并且未能提供相同的用户体验。我们最终通过为两者使用相似的技术基础来“合并”了这两个项目。作为我们工作的一部分,我们还彻底重构了swagger-js。
所以现在只有一个项目了?
嗯,不是。我们创建了一个新的可插拔系统。Swagger-UI现在包含了该系统的核心,而编辑器则只是一组添加到其中的插件。我们仍然为您提供一种将swagger-editor作为项目运行的方式,而无需了解这些插件如何工作。
为什么要费这么大周章?
原因有很多
- 如上所述,是为了合并技术并转向新技术。这些项目已经老旧,是时候进行更新了。
- 我们希望为这两个项目提供一个熟悉的UI界面。
- 为您提供更多的可定制性。多得多。
- 为您提供更多的可扩展性。你猜对了,多得多。
- 为了让我们更容易支持下一个版本的规范。
- 为了提高渲染和验证的性能。
- 为了改进编辑器中的验证,让用户更容易从头编写规范。
嘿,UI怎么了?!我更喜欢Swagger-X的UI!
我们汲取了现有项目的精华,并进行了更新,瞧!我们可能会在未来几周进行更多更改,当支持下一个版本的规范时,肯定会有更多更改。
但我想要旧的外观和感觉!
这就是新项目的妙处——如果您想根据自己的需求修改UI,现在会容易得多。
它支持下一个版本的规范吗?
如上所述,此次变更的主要原因之一是为了让我们更容易支持下一个版本的规范。这是我们待办事项清单上的下一个主要任务。
以前版本项目中的问题怎么办?它们会继续开发吗?我们能期待多长时间的支持?
考虑到下一个版本的规范以及我们投入新项目的工作,我们不再积极开发以前的版本。我们的精力都集中在新版本的项目上。我们将继续支持旧版本几个月,以便每个人都有足够的时间进行过渡。我们将发布一份关于正式停止支持的官方公告。在某些情况下,我们仍然会提供旧项目的新版本,具体取决于问题的严重程度。
新项目支持哪些规范版本?
2.0,并且我们正在努力支持下一个版本的规范。更旧的版本不再受支持。对于那些仍在使用2.0以下版本规范的用户,我们鼓励您花时间考虑升级它。
它缺少功能X!功能Y坏了!
哎呀。我们已尽力做到功能对等,但很可能遗漏了一些。请通过在项目上提交工单来帮助我们报告缺失的功能。
我能如何提供帮助?
就像您以前做的那样
- 有什么东西不工作?提交工单!
- 缺少了什么?提交工单!
- 您想看到更多?提交工单!
- 有时间解决上述任何问题?提交PR(拉取请求)!
就这么简单。