终极 API 开发指南：策略、工具、最佳实践

了解 API
本节的目的是简要介绍 API。本节的确定受众是对 API 知之甚少或一无所知的普通受众。
什么是 API？
应用程序编程接口 (API) 允许产品或服务与其他产品和服务进行通信。在通信过程中，支持的过程保持隐藏状态，提供灵活性、简单的设计、管理和使用。API 供应商的主要目标是向其他企业提供创新和易于构建产品。
对于知道如何实施它们的公司来说，他们可以削减成本、提高效率并帮助实现底线。

API 如何工作？
将 API 理解为合同或协议。协议允许双方相互通信或交换服务的方式与 API 的工作方式类似。Party 1 向 Party 2 发送远程请求，Party 2 以响应或回答查询来响应请求。

API 的工作原理

API 类型和版本
API可以通过三种方式发布。它们也称为 API 类型

Private：构建供内部使用。
合作伙伴：构建仅供特定业务合作伙伴使用。
公开：所有人都可以使用，也称为 Open API。
复合 API：组合不同的服务和数据 API。
API 类型和协议

API 开发术语
Endpoint： API有两点，一端是Endpoint。
API 密钥：请求者必须指定称为 API 密钥的授权代码才能传递请求。
JSON：用于 API 请求的通用数据格式。
GET ：获取资源的 HTTP 方法。
POST：构建资源的HTTP方法。
REST：编程架构实现，提升沟通效率。
SOAP：用于共享信息的消息传递协议。它与 XML 和应用层协议兼容。
延迟： API 提供响应所花费的时间。
API 节流：调节 API 性能称为节流。它被监视以分析 API 的性能。
企业如何通过构建 API 获得收益？
您的移动应用程序业务对 API 的需求。

通过API开发流程，企业可以创新、获得机会并快速成长。以下是了解企业如何使用 API 进行创新的示例。

假设您是像 Google 地图这样的数字导航解决方案提供商。您拥有自己的应用程序和自己的用户群。一家食品配送企业希望在其业务中集成地图功能，让客户和配送合作伙伴查看彼此的确切位置。

在这种情况下，他们有两种选择。

从头开始构建自己的地图系统。
或者将您的服务嵌入到他们的应用程序中。
如果我们考虑案例 1，那么构建另一个强大的解决方案将花费他们巨大的成本。

如果我们考虑案例 2，那么作为导航业务的您必须为他们提供一种简单的集成方式。在共享您的代码或应用程序时，它必须与他们的操作系统平台兼容。您的 iOS 应用程序将与他们的 Android 应用程序不兼容。

因此，最终的解决方案是构建一个 API，充当您的应用程序与他们的应用程序之间的通信系统。他们可以将您的系统嵌入到他们的应用程序中，并以最低的预算实现高质量的效率。

因此，企业通过构建 API 可以获得以下好处：

通过使用 API 加速新的创业公司以节省成本。
合作机会带来增长。
来自第三方的多个应用程序中的营销服务。
吸引第三方客户使用他们的主要应用程序。
促进开放式创新和加速其他企业的渠道。
扩大品牌影响力，带来增长。
掌握API开发策略
您已经阅读了关于 API 的简短介绍；现在，我们准备谈谈 API 开发。但是，在实际开发之前，你必须确定API的开发策略。

API 开发策略要求您回答三个问题：原因、内容和方式。让我们了解一下。

API开发策略的“为什么”
为什么的主要目标是关注 API 开发对业务的价值。

通常，您可能将这些值与 API 开发相关联：

发展 B2C 或 B2B 生态系统
内容分发
带来全新的创新商业模式。
内部使用的开发创新。
简化后端系统
参与数字创新
引用社交照片分享网站 Flickr 的例子，它与多个合作伙伴合作以产生信任。

一旦确定了与 API 开发相关的原因，就可以转到“什么”。

API开发策略的“什么”
API 开发将做什么影响整体业务战略？要确定“什么”API 开发的部分，您必须定义组织的内部和外部视图。

内部观点：组织流程中的宝贵资产。
外部视图：市场、趋势、竞争对手、消费者以及组织外部的一切。
在这里引用示例，地图 API 被出售给多个组织和政府以提供导航和规划。

API开发策略之“How”
现在您已经确定了为什么以及 API 开发策略是什么，您必须考虑 How 部分。您将如何构建 API 程序以实现您的业务价值和目标。在这里，您可以尝试找出与您的 API 开发相关的以下要素：

设计
维护
促销策略 - 内部或外部
确定 API 团队
成功监控
建立 API 团队
由于团队对于组织中的多项任务很重要，因此 API 开发工具需要一个团队。该团队负责为您的企业构建、部署、运营和优化 API。你必须：

聘请项目负责人
聘请设计师
获得经验丰富的开发人员。
聘请测试人员进行质量保证。
聘请安全专家
API 程序可能很大，确保团队协作非常重要。

成功的 API 开发团队的最佳实践
一旦您制定了策略并组成了您的团队，就该构建 API 了。但是，在构建 API 时，您必须优先考虑一些实践，以确保其成功。总之，这里是最成功的 API 开发团队的最佳实践。

专注于 API 的价值
在确定 API 开发策略时，我们讨论了“为什么”因素中的价值。在开发过程中，价值观再次成为需要考虑的非常关键的因素。

福特汽车公司平台总监引述API 程序必须：

提供有价值的服务
确定计划和商业模式。
实现简单性、灵活性和易于采用。
易于测量和组织。
为开发人员提供最好的支持，简化他们的编码部分。
如果没有用户组（无论是其消费者和企业还是开发人员）从您的 API 中获得特定价值，那么您的 API 将无法持续。

为了通过API开发达到上述效果，您可以按照一定的步骤进行。

确定用户和开发人员的问题。
分析针对用户群的痛点，以增强您的解决方案。
确定用户从您的 API 中获得的好处。
对商业模式有清晰的认识
根据您的 API 调整业务模型永远不是一个可持续的选择。它最终会增加快速成本。因此，构建一个业务模型并根据它调整您的 API 开发。

为了确定业务模型，您需要清楚地了解以下内容：

市场需求
客户群
接触客户的分销渠道。
贵公司的收入模式。
您可以使用 Strategyzer 的业务模型画布来获得清晰的业务模型。甚至 Netflix 也这样做了。

2013 年，Netflix 关闭了其公共 API，以根据其新的业务模式（即在线数据流）重新调整其 API。Netflix 已将其私有 API 的访问权限授予极少数与 Netflix 合作的应用程序。

在设计和实施 API 时牢记用户
你有没有注意到汽车里的东西？您购买的每辆汽车的齿轮、赛车、转向和大部分驾驶元素都保持不变。为什么？因为汽车知道司机必须能够驾驶每辆车，并且在切换到一家或另一家公司时不会遇到任何问题。API开发也是如此。您的 API 必须是：

简单我实现简单的数据格式、方法结构、数据模型和身份验证。
灵活地交付最有价值和最可行的用例。
容易被开发者采用。
API操作应该放在最前面
API 操作必须符合开发人员的期望，开发人员将使用它来获得价值、易用性和灵活性。

根据API 操作甜甜圈，您可以将 API 操作保持在顶部。这是它的样子。

API 操作甜甜圈

API Operations Donut（Slack、Chambers & Johnston 2007 年出版的运营管理书籍）

打造引人入胜的开发者体验
开发人员是您的第一批用户，他们首先会使用您的 API。如果开发人员在使用您的 API 时找不到引人入胜的体验，他们可能会寻找其他替代方案。

您可以遵循以下做法来提高开发人员的参与度：

清除有关 API 目标的信息。
快速注册
绝对自由流畅。
价格显示清晰。
提供清晰明了的文档。
此外，您可以构建开发人员平台。如果开发人员在使用您的 API 时遇到问题，可以发布他们的查询并获得答案。此外，开发人员计划将为开发人员提供明确的价值，并为您的企业带来巨大的品牌价值。以下是 RedHat 显示的开发人员程序的元素。

打造引人入胜的开发者体验

超越营销
一些企业构建 API，但仅在 Hackathons 等技术门户网站上进行营销。您必须像推销任何其他产品一样推销您的 API。虽然，主要概念应该是将它推销给合适的人。一些从事 IT 业务的企业家根本不是技术背景。但他们可能对您的 API 感兴趣。

使用以下方法营销您的 API：

执行适当的分段
评估目标市场
在消费者心目中的正确定位。
因此，通过执行这些步骤，您可以为您的 API 启动正确的营销流程。

不要忘记 API 的维护和更新
经过繁重的设计、开发和营销过程后，您的 API 可能会到达合适的用户。但是，如果您的 API 与开发人员的反馈不一致，它就无法生存足够长的时间。

具体来说，确保您：

定期解决bug
不断优化您的 API。
使其流畅的新方法和功能。
删除需要更多资源的不需要的方法。
推出最新版本的 API。
一旦正确维护它，就可以延长 API 的生命周期。

构建 API 时要牢记的技术提示
API 规范框架：您可以遵循 OpenAPI/Swagger 等规范，以获得更好的工具互操作性。此外，每次代码更改时，都要关注 SDK、UI 点和文档。

版本控制：在您的 API 中强制执行版本控制信息，以便用户可以查看他们是否在旧版本上运行。通常，版本信息是在这样的 URL 中给出的。

HTTP
1个
/api/v1/客户

过滤和分页： 对查询使用 LIMIT 和 OFFSET 语句进行过滤和分页。这是返回切片的 MySQL 语句示例。

MySQL
1个
从客户中选择* LIMIT 5 , 10

和一个 JSON 响应。

JSON
1个
// _链接
2个
{
3个
“第一”：“ / api / v1 /客户？页= 1 ” ,
4个
“prev”：“ / api / v1 /客户？页= 1 ” ,
5个
“下一个”：“ / api / v1 /客户？页= 3 ” ,
6个
“最后”：“ / api / v1 /客户？页= 9。”
7
}
8个
的
9
的

使用 REST 和 HATEOAS： 应用一些设计注意事项，例如在端点公开订单列表：

JSON
1个
GET / api / vi /命令
2个
的

安全端点： 确保 HTTPS 连接以实现安全通信。

API开发工具
Apigee：是谷歌的API管理工具，帮助用户加速数字化转型。
API Science：该工具旨在评估内部和外部 API 的性能。
Postman： API 工具链使开发人员能够测试和运行 API 的性能评估。