首页 博客 SwaggerHub 101 回顾...

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

Ryan Pinkham
  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 支持用于描述 API 的Swagger (Open API) 2.0 语法。API 定义的默认格式为 YAML。您也可以粘贴 JSON 文本，但在保存 API 定义时会将其转换为 YAML 格式。 您可以以两种格式（YAML 和 JSON）下载您的 Swagger 规范。

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

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

SwaggerHub 中有哪些可用的集成？

SwaggerHub 专为团队在整个 API 生命周期中进行协作而构建。因此，SwaggerHub 支持团队开发 API 所依赖的工具。 这些集成包括： 了解有关 SwaggerHub 可用集成的更多信息。

如何模拟 API 后端服务器？

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

SwaggerHub 如何帮助我记录 API？

SwaggerHub 可以提供以下有关文档的内容。
  1. 用户可以直接在 Swagger 编辑器中定义和记录 API 的各个方面，并且可以在交互式文档选项卡中看到它们以可视化方式呈现，供最终用户使用、理解和集成。
  2. 用户可以使用我们 API 的内置 HTML 下载生成一个基本的类似开发人员门户的界面。您可以下载 API 文档的引导版本，该版本会显示您的端点和 6 个不同的客户端 SDK，并且您可以随时添加更多。
swaggerpetstore2 按照以下步骤获取您的 HTML 渲染： 步骤 1：转到 SwaggerHub 上您的一个有效 API 步骤 2：单击右上角的下载图标，然后从客户端下载中选择 html2 选项 publish-swagger 步骤 3： 将 zip 文件下载到您本地计算机上的已知位置。转到下载位置，解压缩文件夹，然后打开下载的、解压缩的文件夹中存在的 HTML 文件。

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

是的。已经有 SwaggerHub 的本地部署版本。这是企业版 SwaggerHub 计划的一部分。要了解本地部署版本是否适用于您的组织，最好直接联系 SwaggerHub 团队：[email protected]。

错过了培训？按需观看。

或者注册参加即将到来的培训。
还有其他关于 SwaggerHub 的问题吗？请发送电子邮件至 [email protected] 或在 Twitter 上联系我们：@SwaggerHub。

您可能也喜欢