SwaggerHub 101 回顾：您最关心的 SwaggerHub 问题解答

2016年10月04日

我们最近推出了面向 SwaggerHub 用户的免费培训。这些培训旨在通过向您介绍 SwaggerHub 的不同功能和平台能力，帮助您充分利用 SwaggerHub。您可以在此处找到即将举行的 SwaggerHub 101 培训的完整列表。作为培训的一部分，学员有机会向 SwaggerHub 团队成员提问并获得解答。以下是我们最近一次SwaggerHub 101 培训中收到的热门问题回顾：

“显示评论”是什么？它是如何工作的？

评论功能是 SwaggerHub 内置的协作功能之一，允许不同的利益相关者在 SwaggerHub 编辑器中对 API 定义进行评论。协作者可以根据参与 API 设计过程所需的访问权限量来分配特定角色。例如，协作者可以被授予编辑 API 的能力（编辑者）、对 Swagger 规范的单个行进行评论（评论者），或者只是查看 API（查看者）。使用评论讨论想法或指出 SwaggerHub 编辑器中 API 定义特定行的问题。 comments

评论可用于分享反馈或提出问题，并可标记为开放或已解决。“显示评论”按钮将显示所有评论，包括开放和已解决的评论。了解更多关于使用 SwaggerHub 协作的信息。

SwaggerHub 支持 JSON 还是 YAML？

SwaggerHub 支持Swagger (OpenAPI) 2.0 语法来描述 API。API 定义的默认格式是 YAML。您也可以粘贴 JSON 文本，但在保存 API 定义时会将其转换为 YAML 格式。您可以下载 YAML 和 JSON 两种格式的 Swagger 规范。

在 SwaggerHub 中发布 API 会发生什么？

发布是一种告知他人 API 处于稳定状态的方式，它将按设计运行并可供应用程序使用。当您在 SwaggerHub 上发布 API 时，该 API 将变为只读，并且只有在再次取消发布后才能进行编辑。如果需要改进描述文本或修正拼写错误，暂时取消发布 API 是可以的。但对于破坏性更改——例如新的操作或参数——您应该通过在 SwaggerHub 编辑器中使用添加版本命令来启动一个新版本。 SwaggerHub 允许您维护 API 规范的多个版本，因此您可以在开发下一个 API 版本的同时保持已发布版本（“生产”版本）不变。了解更多关于在 SwaggerHub 上发布 API 的信息。

SwaggerHub 中有哪些可用的集成？

SwaggerHub 旨在帮助团队在整个 API 生命周期中进行协作。因此，SwaggerHub 支持团队开发 API 所依赖的工具。这些集成包括：

SCM（源码管理工具）：将您的 API 与GitHub 和BitBucket 同步
API 管理：将您的 API 部署到Amazon API Gateway & Lambda 和Microsoft Azure
模拟：使用VirtServer 虚拟化 API 动作
Webhooks：使用Webhooks 触发自定义操作
测试：将 API 导入Ready! API 进行无缝测试

了解更多关于 SwaggerHub 可用集成的详细信息。

如何模拟 API 后端服务器？

SwaggerHub 集成了 VirtServer，它是 SmartBear Ready! API 虚拟化产品的一部分。启用后，VirtServer 集成会自动创建并维护 SwaggerHub 中定义的 API 的半静态模拟。每次保存 API 时，此模拟都会更新，这意味着您不再需要寻找和使用外部工具来创建模拟服务。通过 VirtServer 生成的预览，您只需几次点击即可与团队高效地迭代设计。模拟服务器在推敲 API 设计时可以成为一个强大的工具。无需编写任何代码，您就可以让 API 使用者针对 VirtServer 开发客户端，VirtServer 保证会以兼容、真实的有效载荷响应。了解更多关于使用 SwaggerHub 模拟 API 的信息。

SwaggerHub 如何帮助我文档化 API？

SwaggerHub 可以在文档方面提供以下功能。

用户可以直接在 Swagger 编辑器上定义和文档化 API 的各个方面，并可以在交互式文档选项卡中看到它们以可视方式呈现，供最终用户使用、理解和集成。
用户可以通过我们内置的 API HTML 下载功能生成一个基本的开发者门户式界面。您可以下载 API 文档的引导版本，其中显示了您的端点以及 6 种不同的客户端 SDK，并且您随时可以添加更多。

按照以下步骤获取您的 HTML 渲染：步骤 1：访问 SwaggerHub 上您的一个有效 API 步骤 2：点击右上角的下载图标，并从客户端下载选项中选择 html2 选项 publish-swagger

步骤 3：将 zip 文件下载到您本地机器上的已知位置。前往下载位置，解压文件夹，然后打开已下载、已解压文件夹中的 HTML 文件。

是否有计划提供一个可以连接到本地 SCM 系统的部署版本？

是的。SwaggerHub 已有本地部署版本。这是企业 SwaggerHub 计划的一部分。了解本地部署版本是否适合您的组织的最佳方式是直接通过[email protected] 联系 SwaggerHub 团队。

错过了培训？点播观看。

或注册参加即将到来的培训。

还有其他 SwaggerHub 问题？请发送电子邮件至 [email protected] 或在 Twitter 上联系我们：@SwaggerHub。