在这种分布式基础设施中，有大量的 API 将各种组件集成在一起。Bonotel 使用 Swagger (OpenAPI) 规范来定义这些不同的服务。
在开始使用 Swagger 时，团队利用开源 Swagger 工具来设计、构建和文档化 RESTful API。但当他们需要将 API 开发扩展到内部和外部团队时，很快就面临了挑战。鉴于他们 API 开发的广度，有如此多的利益相关者参与他们的 API 项目，集中管理所有 API 资产变得越来越困难。
由于缺乏一种简单的方式让利益相关者能够及时快速地访问正确的 API，并在新 API 定义的协作中避免混淆，这影响了他们整体的 API 交付速度。曾几何时，Hastings 和他的团队甚至考虑构建一个自定义组件，用于可视化存储在他们版本控制系统中的 API 定义，以便 Bonotel 的内部和外部团队可以集中访问它们。
“随着项目深入，我们意识到需要加快流程并提高效率，”Hastings 指出，“我们希望自动生成用户界面，并促进内部和外部团队之间的协作，避免麻烦或沟通问题。”
Hastings 希望改进的另一个关键功能是跟踪不同 API 版本的能力。团队越来越难以跟踪 API 在不同版本中的所有更新。
“我们所有的 API 都是私有的，我们使用细粒度的访问控制来开放我们的 API，以便我们的合作伙伴可以查看它们，”Hastings 解释说，“我们还为合作伙伴创建用户帐户，以便在适当的时候赋予他们编辑权限。有如此多的人处理 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 设计和文档中需要解决的开放问题。
“SwaggerHub 极大地改善了我们内部团队与外部合作伙伴之间在 API 开发方面的沟通，”Hastings 强调，“这很关键，因为我们内部不进行大量的 API 开发——大部分工作都是通过我们的合作伙伴完成的，他们之间也相互协作。SwaggerHub 充当了所有活动部分的集中协作主机，使整个过程非常高效、直观和无缝。”
减少 API 开发中的困惑
Bonotel 的内部开发和 QA 团队，以及外部合作伙伴都使用 SwaggerHub 进行有效协作，作为一个整体共同工作。SwaggerHub 解决方案不仅节省了他们大量的 API 开发时间，还消除了协作时的困惑和效率损失，并抽象化了原本与正确访问控制的 API 文档托管相关的基础设施考量。SwaggerHub 还允许 Bonotel 跟踪其 API 的新更改和更新。SwaggerHub 的版本控制机制，辅以可视化比较和合并功能，确保 Scott 和他的团队清楚地知道哪个 API 被更新了，以及更新后的 API 中添加了哪些更改。
现在，SwaggerHub 已成为内部团队和外部开发人员之间的关键协作工具，Hastings 和他的团队现在可以遵循 API 优先的开发方法。
“这让事情变得更清晰，”Hastings 补充道，“我们可以在一个集中、安全托管的环境中，将 API 的设计和文档与协作结合起来。” Hastings 说：“通过让我们能够更快地设计和开发 RESTful API，我们可以更快地推出新服务和更新服务。这使得 SwaggerHub 成为我们软件开发生命周期中的关键环节。”
改变您的团队共同设计和文档化卓越 API 的方式
对于 Bonotel 来说，转向 SwaggerHub 的好处是显而易见的。这些好处包括：
- 将 RESTful API 设计和文档结合起来，实现协作开发
- 让团队无缝协作，避免任何混淆
- 使用 SwaggerHub 评论功能实现各利益相关者之间的轻松沟通
- 便于版本控制，轻松为现有 API 添加新更新
- 加快新 API 和服务的上市速度
改变您的团队共同设计和文档化 API 的方式。立即免费试用 SwaggerHub！