自集成功能发布以来,SwaggerHub 团队一直致力于为您的 API 项目提供最好的工具。尽管 SwaggerHub 编辑器本身是一个强大的工具,可以编写和可视化您的 Swagger 定义,但如果设计师可以快速迭代 API 的实际行为,设计过程会大大改进。从客户端的角度来看 API 的外观和感受是构建出色 API 的开始,我们最新的集成正是实现了这一点——Smartbear VirtServer 集成!VirtServer 是 SmartBear Ready! API 虚拟化产品的一部分。SwaggerHub 中的 VirtServer 集成将基本的虚拟功能直接集成到 API 生命周期中。启用后,VirtServer 集成会自动创建和维护 SwaggerHub 中定义的 API 的半静态模拟。每次保存 API 时都会更新此模拟,这意味着您不再需要查找和使用外部工具来创建模拟服务。通过 VirtServer 生成的预览,您只需点击几下即可与团队高效迭代设计。
启用 VirtServer
就像 SwaggerHub 的 GitHub 同步或 Webhook 集成一样,SmartBear VirtServer 集成可以从右上角的“管理集成”选项添加到 API 中。
当您看到添加和配置集成是多么容易时,就能体会到 SmartBear VirtServer 集成的真正实用性。以下是您可以用来根据设计需求优化 VirtServer 的字段:
- 名称: 这是特定 VirtServer 集成的名称。
- API 令牌: 一旦指定了任意 API 令牌并启用了集成,对模拟服务器的每个请求都需要在 Authorization 标头中包含此令牌。这仅适用于 SwaggerHub 上的私有 API。
- API 令牌: 一旦指定了任意 API 令牌并启用了集成,对模拟服务器的每个请求都需要在 Authorization 标头中包含此令牌。这仅适用于 SwaggerHub 上的私有 API。
- 默认响应内容类型: 如果未在 API 规范中指定,模拟将返回的默认响应内容类型。
- 更新主机设置: 允许集成修改您的 Swagger 规范,以更新 basePath、host 或 schemes 属性,使其自动指向模拟。这使得编辑器和交互式 UI 可以直接调用虚拟服务器,并配置自动生成的客户端 SDK 指向该服务器。
一旦集成启用,模拟即可使用!
生成多个已定义响应
此生成的模拟将为每个 produces/response-message 组合创建静态响应。如果一个操作有多个响应,模拟将按顺序循环它们;例如,如果一个操作有 200、404 和 500 响应,它们将按顺序返回该操作。在推敲 API 设计时,模拟服务器可能是一个强大的工具。无需编写一行代码,您就可以让 API 消费者根据 VirtServer 开发客户端,VirtServer 保证会返回兼容、真实的有效负载。更重要的是,您可以通过在模型定义中使用“example”结构直接调整 Swagger 定义中的有效负载。您可以从其文档中阅读更多关于如何设置 VirtServer 集成的信息。此次集成得益于 SmartBear Software 的各位同仁!敬请关注此集成和其他集成的未来增强功能。如果您对新的集成有任何建议,或者希望看到您的产品与 SwaggerHub 集成,请在此提出功能请求。