隆重推出全新 SwaggerHub 编辑器:更智能的编辑器,加速 API 设计

  2017 年 3 月 7 日

SwaggerHub 一直致力于提供最快、最易用的平台,用于使用 Swagger 设计、记录和构建 API。SwaggerHub 平台的核心是一个强大的基于云的编辑器,可让您通过适量的反馈和帮助来设计和记录 API。 自 SwaggerHub 发布以来,我们收到了用户的大量反馈,了解他们对编辑器最需要什么,以及我们如何更好地改进编辑器的功能以满足他们的需求。 在过去的几个月中,SwaggerHub 团队一直在努力实施基于我们收到的反馈的几项重大改进。除了编辑器中推出的一些新功能外,幕后还进行了大量工作来提高编辑器的速度和稳定性,以确保各种大小的 Swagger 文件的设计流程顺畅。 立即登录亲自试用新的 SwaggerHub 编辑器。(不是 SwaggerHub 用户? 免费注册。) 下面详细介绍了 SwaggerHub 编辑器中的新功能,以及这些新功能如何帮助您在 SwaggerHub 中设计更好的 API。

一个全新的统一编辑器

SwaggerHub 一直允许在编辑器中的 API 的 YAML 语法和 UI 中生成的交互式 API 文档之间轻松切换。但是我们也收到了用户的反馈,他们希望可以选择在编辑器和 UI 中独立工作。这就是为什么在新的 SwaggerHub 编辑器中,我们添加了在拆分视图、仅编辑器视图和仅 UI 视图之间切换的功能。 您可以轻松调整编辑器的大小,以便更轻松地使用 Swagger 定义。并通过单击屏幕顶部的显示选项卡在视图之间切换。 SHSplit

通过智能自动建议更快地编辑

SwaggerHub 编辑器提供语法自动完成功能,有助于加快设计过程并减少编写语法时的常见错误。改进后的编辑器通过使用更智能的自动建议进一步扩展了自动建议功能,从而将速度置于 API 设计过程的前沿。 在您编写时,您仍然会看到 SwaggerHub 编辑器中始终可用的自动生成代码片段和关键字,但您还会看到更多具体的建议,具体取决于您正在使用的规范部分。例如,如果您正在更新 Swagger 定义中的“schemes”,则新编辑器将建议与该值关联的数组项。或者,对于像标签这样在数组下有一个映射的事物,您只会得到数组项,然后您可以从中选择关键字。 autosuggest1 您也可以随时通过单击“ctrl+空格”来查看建议。

更具可操作性的错误消息

SwaggerHub 编辑器一直提供实时验证和错误消息,以帮助您完成设计过程,并确保您符合 Swagger (OpenAPI) 标准。该团队一直在努力了解人们在编写 Swagger 定义时遇到的最常见错误,并更新了错误警告,以提供更具可操作性的见解,以帮助在出现错误时修复错误。 我们发布了第一轮更新的错误消息,并将继续在未来的版本中更新这些消息,以满足 Swagger 用户最常见的用例。 Validator Error

在同一行规范上添加多个注释

团队可以使用 SwaggerHub 协作设计和记录任何 API。SwaggerHub 编辑器现在提供的一项小但高度请求的协作改进是在规范的单行上编写多个注释的能力。 Comments 这允许处理 API 的队友在规范的同一行上提出单独的问题、评论、提供反馈,并通过完成来跟踪单独的对话。

亲自试用新的编辑器

我们很高兴向大家介绍 SwaggerHub 编辑器的这些最新更新。立即登录亲自试用 有评论/问题/反馈?请在下面的评论中告诉我们。