我们很高兴地宣布新的增强功能,这将使组织在 SwaggerHub 中编写 API 文档和共享公共 API 文档变得更加容易。
用于记录 OAS 定义的全新可视化编辑器
您现在无需直接在 SwaggerHub 的 YAML 编辑器中操作即可编辑 API 信息和元数据。
全新的可视化编辑体验非常适合那些可能不直接了解 YAML 语法或需要构建 OAS 定义中重要详细信息(如 API 信息:标题、描述、许可证、联系信息;或操作元数据:摘要、描述、标签)的技术文档编写人员。
在可视化编辑器中所做的更改将自动与 YAML 代码编辑器同步,并实时在 UI 视图中显示。该编辑器还支持 Markdown 语法,允许对技术文档应用不同的格式和样式,这在 YAML 编辑器中描述可能很繁琐。
注意:这是 SwaggerHub 中可视化编辑器的首次发布。未来,我们将添加更多增强功能,用于描述端点、请求头、请求体等。
访问全新可视化编辑器
要切换到可视化编辑器,请单击 SwaggerHub 编辑器侧边栏中的“显示可视化编辑器”(Show Visual Editor)。如果光标位于 YAML 代码中的特定操作内,可视化编辑器将针对该操作打开。

选择左侧“导航”(Navigation) 面板中的一个项目。如果导航面板被隐藏,请单击侧边栏中的“显示可视化编辑器”图标以显示它。

探索全新可视化编辑器
将公司徽标和品牌添加到 Swagger UI 文档
组织现在可以将其自己的品牌添加到 SwaggerHub 中托管的 API 文档。新的可定制文档功能非常适合利用 SwaggerHub 共享外部 API 文档的组织。
新功能允许组织上传其公司徽标以替换标准 SwaggerHub 徽标,并自定义页眉颜色以匹配其企业品牌。

文档品牌化功能适用于团队版和企业版计划的组织。
访问全新文档品牌化功能
组织所有者可以在组织设置的“文档品牌化”(Docs Branding) 页面上配置品牌化选项。
- 点击您的用户名并选择“设置”(Settings)。
- 切换到“我的组织”(My Organizations) 选项卡。
- 选择左侧侧边栏中的“文档品牌化”(Docs Branding)。

探索全新文档品牌化功能
与 Azure DevOps Services 集成
新的 Azure DevOps Services 集成允许您将您的 API 定义、自动生成的服务器代码或客户端 SDK 与 Azure DevOps Services(以前称为 Visual Studio Team Services 或 VSTS)中现有的 Git 仓库同步。每次您在 SwaggerHub 中保存 API 时,该集成都会更新指定仓库中的代码。
Azure DevOps Services 集成是 SwaggerHub 中最新添加的源代码控制集成,此外还有与 GitHub、GitLab 和 Bitbucket 的现有集成。
访问全新集成
- 在 SwaggerHub 编辑器中打开您的 OAS 2.0 或 OAS 3.0 定义。
- 如果 API 有多个版本,请选择您想要与 Azure DevOps Services 中的仓库同步的版本。

- 点击 API 名称以打开 API 信息面板。
- 在 API 信息面板中,切换到“集成”(Integrations) 选项卡,然后点击“添加新集成”(Add New Integrations)。

- 从集成列表中选择“Azure DevOps Services”。
探索 Azure DevOps Services 集成
开始使用 SwaggerHub
所有这些最新更新均可在 SwaggerHub 团队版和企业版计划中使用。 登录并亲自尝试或立即开始免费试用。