为 2018 年规划您的 API 战略:帮助您的团队取得成功的工具和资源

  2017 年 12 月 21 日

SwaggerHub 的创建旨在帮助团队重新思考他们交付 API 的方式。

在 2017 年,超过 70,000 名 API 开发人员、设计师、技术作家和产品经理开始使用 SwaggerHub。在那段时间里,我们学到了很多关于 API 团队如何大规模设计、编写文档和交付 API 的知识。

我们还了解了很多关于组织在多个团队处理数百个 API 时面临的挑战。

诸如此类的挑战

  • 如何确保每个参与者都能看到 API 的更改?
  • 如何在更新和版本化 API 的同时,确保您的文档保持最新?
  • 如何确保 API 设计的一致性,并强制执行 API 构建的标准?
  • 如何改进您的设计流程并采用像 OpenAPI 3.0 这样的新标准?

今年,我们发布了一些新的工具和资源,以帮助解决 API 团队面临的这些挑战和其他挑战。我们还联系了 API 领域的行业领导者和创新者,以了解他们对交付出色 API 的看法。展望 2018 年,我们想分享我们的一些最佳资源,并回顾一下新的 SwaggerHub 功能,以便在新的一年里帮助您的团队取得成功。

团队交付出色 API 的工具

我们在 2017 年初发布了三项新功能,旨在帮助团队更好地管理 API 设计和文档工作流程:样式验证器用于设置和强制执行 API 样式指南,比较和合并用于查看和合并设计更改,以及项目用于在团队内组织 API。

我们还发布了与两个领先的 API 网关 Apigee 和 IBM API Connect 的新集成。

为了结束 2017 年,我们添加了对使用最新版本的 OpenAPI 规范 OpenAPI 3.0 设计和文档编写 API 的初步支持。

规划您的 API 战略

在 2017 年,我们继续看到越来越多的组织采用产品管理原则来交付 API,并承认现代“API 经济”的商业机会。我们还看到,团队越来越需要一种策略来解决 API 的整个生命周期,从规划和设计到文档、测试和部署。

以下是一些规划 API 战略的顶级资源

来自 API 行业的见解

在这一年里,我们有机会联系了来自 API 世界各个领域的专家,了解他们对从 API 设计、协作到一些世界上最好的 API 团队如何实施成功的 API 策略的广泛主题的看法。

请查看下面我们最受欢迎的访谈

规划和扩展您的 API 设计流程

像 OpenAPI(以前的 Swagger)这样的描述格式越来越受欢迎,这导致人们更加关注 API 开发的“设计优先”方法。因此,组织正在投入更多的时间和精力来标准化他们的 API 设计流程,并为 API 的设计方式制定要求。

了解如何使用这些资源标准化和扩展您的设计流程

通过 API 文档改进 API 开发人员体验

API 文档是使用 OpenAPI 的团队的最大用例之一,也是像 Swagger UI 这样的工具如此受欢迎的主要原因之一。良好的文档有助于提高用户采用率,减少支持咨询,并为使用您的 API 的人员带来更好的体验。

今年,我们发布了许多资源来帮助初学者和经验丰富的 API 团队记录他们的 API。

开始使用 OpenAPI 3.0

OpenAPI 倡议组织(该组织负责促进 OpenAPI 规范的开发)于 2017 年 7 月正式发布了该规范的最新版本。OpenAPI 3.0 是 Swagger 规范的下一个发展方向,除了正式更名外,还提供了改进和新功能,以帮助团队在其 API 的整个生命周期中利用该规范。

自发布以来,我们举办了三场培训,并发布了许多新的资源和文档来帮助入门

您想在 2018 年了解有关哪些 API 主题的更多信息?在下面的评论中分享您的问题。