自集成功能发布以来,SwaggerHub 团队一直在努力为您的 API 项目带来最好的工具。虽然 SwaggerHub 编辑器本身是一个强大的工具,可以编写和可视化您的 Swagger 定义,但如果设计人员可以快速迭代 API 的实际行为,设计过程可以得到极大的改进。从客户端的角度处理 API 的外观和感觉是构建出色 API 的开始,而我们最新的集成正是如此——Smartbear VirtServer 集成!VirtServer 是 SmartBear Ready! API 虚拟化产品的一部分。SwaggerHub 中的 VirtServer 集成将基本 virt 功能直接集成到 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 保证会使用兼容的、真实的有效负载进行响应。更重要的是,您可以使用模型定义中的“示例”构造直接在 Swagger 定义中调整有效负载。您可以从其文档中阅读有关如何设置 VirtServer 集成的更多信息。此集成归功于 SmartBear Software 的人员!敬请期待此集成和其他集成中的未来增强功能。如果您对新集成有任何建议,或者希望看到您的产品与 SwaggerHub 集成,请在此处提交功能请求 这里。