[](https://res.cloudinary.com/practicaldev/image/fetch/s--am0gq5DO--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_880/https://dev-to- uploads.s3.amazonaws.com/i/sqd888r878y9ukykx9lz.jpg)

原帖是在API Development Lifecycle和封面图片由Jason Rosewell 在 Unsplash

简介

谈到 API 开发生命周期。我发现没有太多关于它的信息可以理解。哪个是 GraphQL 比谈论 API 开发更受欢迎。

对我来说,API 开发更像是基础设施的管道工作,但谈论它并不性感。哪些服务器、前端和最新或最好的人工智能取决于它。如果没有为他们提供数据的 API,任何前端、服务器集成和 AI 都没有它的价值。数据被认为是 21 世纪的珍贵商品。

什么是API开发生命周期?

API 开发生命周期涵盖了从设计到发现阶段用于创建 API 的步骤。最好通过 API 市场发现它。

谁正在寻找服务或数据以集成到他们的产品或服务中。增加它为客户或用户提供的价值。我将使用API Evangelist 的 API 生命周期,因为它似乎涵盖了 API 开发生命周期的广度。

• 定义 - 使用定义作为 API 设计过程的中心,开发 OpenAPI 合约。用于在设计阶段移动事物、迭代、发展并确保定义驱动每个服务背后的业务目标。

• 设计 - 我们构建了一个剧本,我们着眼于为所有 API 设计的方法。重点是始终如一地跨团队提供服务。从 REST 开始,但最终也允许在服务交付方面利用超媒体、GraphQL 和其他模式。

• 版本控制 - 管理每个 API 合同的定义,这些合同被定义为生命周期这一领域的 API 设计停止的一部分,并采用连贯的方法来布置后续步骤。

• 虚拟化 - 一个包含 API 模型和模拟数据的沙盒环境。这准确地反映了它在生产环境中的行为方式。

• 测试——不仅仅是测试。使用模式进行验证,确保在粒度级别上测试服务。准备好测试用例。每个服务都在做完全,它应该做什么,仅此而已。

• 登陆页面 - 确保每个单独的服务都被设计为一个登陆页面,用于在设计阶段访问其文档和其他元素。

• 文档 - 确保 API 文档是全面的、最新的。如果可能的话,可交互并适用于所有正在设计的 API。对于所有利益相关者来说,很容易理解 API 将要完成的事情。

• 支持 - 确保有可用于 API 的支持渠道。利益相关者知道在实时或接近实时地提供反馈和回答问题时与谁联系,从而推动设计过程。

• 沟通 - 确保有一种沟通策略可以在设计阶段移动 API。了解利益相关者作为流程的一部分参与,并定期更新正在发生的事情。

• 路线图 - 关于正在开展的工作的路线图。随着每项服务的设计,由开发团队推动。

• Discovery - 确保所有 API 在经过设计阶段后都是可发现的。确保每种类型的 API 定义都是最新的,并且目录作为流程的一部分进行更新。

API开发生命周期分析

基于 API 开发生命周期。它包含用于 API 开发的各种技能组合。

其中每一个都有自己的专业技术技能。我个人认为,我遇到的大多数 API 在 documentation、support 和 discovery 阶段都达不到要求。在开发团队完成了艰苦的工作之后。

拥有优秀的文档可以减少 API 所需的支持时间。它用于增强开发人员体验和营销材料。交付给您自己的 API 的潜在用户。

我已经阅读了未能为我提供重要信息的文档。尽管有大量的工作和想法已经为读者或开发人员准备好了。

我只能通过多次试验或错误来使用它。与 API 开发不断沟通。仅在一个 API 端点上持续 3 天或更长时间。这可以通过为任何集成 API 的人提供快速入门来保存。

很棒的 API 文档示例

在与多个公共 API 或其他为我提供 API 服务以集成到我的产品或服务中的 SaaS 公司合作之后。

我发现一些公司在他们自己的开发生命周期的各个方面投入了大量资金。当您希望开发 API 时,用作模型。

• Twilio- 他们甚至有一款名为TwilioQuest的游戏,用于介绍使用自己的 API 的概念。

• SendGrid API 参考- 已由 Twilio 提供。快速启动允许您开始发送交易电子邮件。

• Stripe API 参考- 看看他们的文档是一件很愉快的事,因为他们花费了大量的时间和精力来使他们的文档变得更好。这导致大量开发人员将其集成到与电子商务相关的任何事物中。

• Google News API 参考- 为您提供大量示例,说明如何将其参数用于每个 API 服务。它干净且易于理解的文档使得可以使用它来完成工作。

结论

如果你错过了这篇文章,这里是我到目前为止所涵盖的以下内容:

• API 开发生命周期 - API 开发的各个阶段,从定义到 API 服务的发现方面。

• 分析API开发生命周期 - 我觉得现有API服务的不足之处可以进一步改进。

• 优秀 API 文档示例 - 对于希望为任何人提供数据以用于构建产品或服务的 SaaS 公司或组织而言,这变得更加重要。

我希望通过这篇文章可以帮助您对 API 开发生命周期有一个大致的了解。这超越了 API 请求方法、GraphQL 甚至OpenAPI。

如果您喜欢这篇文章,请注册我的Adventurer's Newsletter,其中包含我在 Python、Web 开发、Startup 领域偶然发现的有趣内容。

您还可以关注我以获取我在 Dev 上的文章的最新更新

参考

• API 传播者的 API 生命周期开发

• 什么是 API 生命周期管理

• 完整的 API 生命周期管理入门

• Twillo API 参考

• TwilioQuest

• SendGrid API 参考

• 条带 API 参考

• Google 新闻 API 参考

• 开放API