Bonotel 如何通过切换到 SwaggerHub 改进协作并加速 API 交付

  2017 年 7 月 17 日

在这样一个分布式基础设施中,有很多 API 将各种组件集成在一起。 Bonotel 使用 Swagger(OpenAPI)规范来定义这些不同的服务。

在他们的 Swagger 之旅的开始,团队利用开源 Swagger 工具来设计、构建和记录 RESTful API。但是,当需要在其内部和外部团队之间扩展 API 开发时,他们很快就面临了挑战。鉴于他们 API 开发的广度,有如此多的利益相关者参与他们的 API 项目,集中管理他们所有的 API 资产变得越来越困难。

利益相关者无法在正确的时间快速访问正确的 API,同时在新的 API 定义上进行协作而不会产生混淆,这影响了他们的整体 API 交付速度。 有一段时间,Hastings 和他的团队甚至考虑构建一个自定义组件,该组件可以可视化存储在其版本控制系统中的 API 定义,以便 Bonotel 的内部和外部人员可以集中访问它们。

Hastings 指出:“随着我们项目的深入,我们意识到我们需要加快流程并提高效率。 “我们希望自动生成用户界面,并促进内部和外部团队之间的协作,而不会出现麻烦或沟通问题。”

Hastings 希望改进的另一个关键功能是跟踪不同 API 版本的能力。 团队越来越难以跟踪不同版本中 API 的所有更新。

Hastings 解释说:“我们所有的 API 都是私有的,我们使用细粒度的访问控制来开放我们的 API,以便我们的合作伙伴可以查看它们。” “我们还为我们的合作伙伴创建用户帐户,通过这些帐户,我们可以在适当的时候授予他们编辑权限。 有这么多人处理 API,我们需要密切跟踪不同的版本。”

从开源 Swagger 工具切换到 SwaggerHub

在使用开源版本的 Swagger 几个月后,Hastings 开始寻找他的团队需要的更强大的解决方案。 一位熟悉 Swagger 技术的 Bonotel 合作伙伴推荐了 SwaggerHub。 SwaggerHub 是 SmartBear Software 的集成 API 设计和文档平台,由 Swagger 背后的团队构建。 在评估该平台后,Bonotel 很快将 SwaggerHub 确定为他们 API 开发工作流程的关键工具。

对于 Bonotel 而言,SwaggerHub 为其内部开发人员和外部利益相关者之间的 API 设计、文档和开发需求提供了中心平台。 SwaggerHub 是为 Swagger(OpenAPI)规范中的 API 开发量身定制的,这一事实使 Scott 和他的团队可以轻松地将其 API 设计和开发过渡到 SwaggerHub。

“我们过去使用过开源的 Swagger 工具链,但由于 SwaggerHub 是围绕核心 Swagger 技术构建的,因此很容易在我们的方面以有限的开销采用该平台,”Hasting 指出。 无缝发现现有 API 或处理新 API 的能力使 Bonotel 的开发团队能够在他们的 API 工作流程中实现一致性和规范性。

“在内部审查该工具并了解 SwaggerHub 如何增强已经融入我们开发生命周期的基本开源 Swagger 功能后,我们立即意识到该解决方案将满足我们的需求,”Hastings 说。 “SwaggerHub 运作良好,我们没有考虑任何其他替代方案。”

使用 Swagger 改造 Bonotel 交付 API 的方式

作为创建 API 的工具框架,SwaggerHub 为 Bonotel 提供了一个用于设计和记录 API 的集中式平台。 细粒度和安全访问控制支持的集中式 API 开发使 Bonotel 能够自信地向外部合作伙伴开放平台,以推动其战略目标。 Scott 观察到的一个明显变化是,使用 SwaggerHub 后,协作变得多么顺畅。 甚至各个团队之间的沟通也明显改善。 SwaggerHub 评论允许 Bonotel 的内部和外部团队不仅可以实时交流重要想法或建议,还可以跟踪 API 设计和文档中需要解决的未决问题。

Hastings 强调说:“SwaggerHub 大大改进了我们的内部团队和外部合作伙伴之间关于 API 开发的沟通。 “这很关键,因为我们内部不做大量的 API 开发——大部分工作都是通过我们的合作伙伴完成的,他们也相互合作。 SwaggerHub 作为所有移动部件之间协作的集中主机,使过程非常高效、直观和无缝。”

减少 API 开发中的混乱

Bonotel 的内部开发和 QA 团队以及外部合作伙伴都使用 SwaggerHub 进行有效协作,并作为一个整体协同工作。 SwaggerHub 解决方案不仅为他们节省了大量的 API 开发时间,还消除了协作时的混乱和效率损失,并抽象了本来与使用正确的访问控制托管 API 文档相关的基础设施考虑因素。 SwaggerHub 还允许 Bonotel 跟踪其 API 的新更改和更新。 SwaggerHub 版本控制机制,由可视化比较和合并功能支持,确保 Scott 和他的团队确切地知道哪个 API 已更新,以及向更新的 API 添加了哪些更改。

随着 SwaggerHub 现在成为内部团队和外部开发人员之间关键的协作工具,Hastings 和他的团队现在可以遵循 API 优先的开发方法。

“这使得事情变得更加清晰,”Hastings 补充道。 “我们可以将 API 的设计和文档与集中、安全的主机环境中的协作相结合。” “通过使我们能够更快地设计和开发 RESTful API,我们可以更快地将新服务和服务更新推向市场,”Hastings 说。 “这使得 SwaggerHub 成为我们软件开发生命周期中的关键齿轮。”

改变您的团队协作设计和记录出色 API 的方式

对于 Bonotel 而言,切换到 SwaggerHub 的好处已经显而易见。 这些好处包括

  • 将 RESTful API 设计和文档结合在一起进行协作开发
  • 允许团队无缝协作,没有任何混乱
  • 使用 SwaggerHub 评论实现各个利益相关者之间的轻松沟通
  • 便于版本控制,轻松为现有 API 添加新更新
  • 加快新 API 和服务上市的速度

改变您的团队协同设计和记录 API 的方式。 立即免费试用 SwaggerHub!