推出全新的 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 编辑器的最新更新。立即登录亲自试用 有任何评论/问题/反馈?请在下方评论中告诉我们。

© . All rights reserved.