什么是 API 门户？
API 门户 基本上用作 API 生产者（API 创建者）和 API 使用者（通常是开发人员社区）之间的桥梁。API 门户允许 API 消费者注册使用您的 API，并在其整个生命周期中获取有关这些 API 的所有必需信息，包括指导开发人员如何集成 API、围绕 API 进行教育、授予或提供用户访问权限、生成客户端密钥以及其他。成功的 API 门户将授予开发人员访问加载生产数据的沙箱环境的权限，以便开发人员可以轻松地测试 API。由于大多数开发人员更喜欢测试 API，因此良好的 API 门户将提供该服务并使其易于访问。
API 门户将您的 API 转换为开发人员可以轻松发现、访问和集成到其应用程序中的产品。您可以使用 API 门户将 API 打包并作为产品推广，并使引导、参与和授权开发人员的流程更加简化。把 API 门户想象成一个商店窗口或宣传册，您可以在其中宣传或托管 API 产品。
API 门户拥有开发人员可能需要的有关 API 的所有信息，包括文档、规格、安全性、定价、任何法律声明以及 API 设计的完整透明度。它可以包括有关实施 API 的业务优势的更多信息，甚至可能是成功使用 API 的一些示例。事实上，我们鼓励这些措施以增加开发人员使用该 API 的可能性。API 门户还应包括任何已知问题、解决问题的时间以及如何寻求帮助。
API 门户不仅仅是单向通信。除了托管有关 API 的文档外，它还具有其他功能，如常见问题解答、文章、讨论论坛和博客。这使消费者和生产者能够提出建议、提出问题并谈论他们的体验。API 提供商可以使用论坛和博客向开发者社区提供更多信息，例如新计划或 API 更改。借助论坛，API 消费者还可以列出反馈和报告故障。一个完整而精心构建的 API 门户将鼓励开发者参与，这是提高 API 使用率的游戏名称。
为什么要使用 API 门户网站？
API 门户使开发人员可以更轻松地进行共享和协作。API 门户应该帮助开发人员轻松入门，如果 API 被停用或更新，还应通知他们。借助 API，您可以制定有关谁可以使用 API 以及如何使用它们的策略和授权要求。您可以定义限制和速率限制等策略，以优化 API 门户中的 API 性能。
开发人员可以使用 API 门户执行的三大主要行动是：
- 注册使用 API，包括自助注册功能
- 浏览和使用 API 的内容并了解如何使用它
- 获取有关使用 API 的常见问题或提交反馈的支持
代码示例和库或软件开发工具包 (SDK) 也应该在 API 门户中提供。这将使开发人员能够立即开始构建。开发人员不是 API 门户的唯一用户。一个组织中许多不同的部门可以出于多种不同的原因使用 API 门户，包括管理其访问权限和门户中其他集成信息的开发人员。API 门户的其他用户包括：
- 营销可以使用它进行消息传递以展示 API 的有价值产品
- 合作伙伴可以使用该门户获得支持，甚至可以展示 API 如何提升其业务的
- 产品经理和技术编写者使用它来展示 API 的所有方面，包括文档
- 所有业务部门都可以使用门户学习、共享和创新
只有易于发现、具有充足文档和透明度的 API 才能被流行应用程序使用。API 必须推广，即使它们只是内部 API 或仅针对合作伙伴的 API。此外，如果您的内部员工获得了授权，这将为您的客户提供更好的服务。
基本上，开发人员可以制定或破坏您的 API 游戏计划。他们的采用对于确保其成功至关重要。精心设计的门户是确保开发人员参与度的好方法，从而确保开发人员采用您的 API-组织的最终目标。基本上，API 门户将回答开发人员希望与 API 互动的的关键问题，例如他们通过使用您的 API 实现的业务价值、他们可以构建什么、您的产品是什么以及 API 如何增强已为客户提供的服务？API 门户还应该让开发人员知道你的 API 有多可靠。开发人员有许多 API 可供选择，他们不希望与古怪的、不可靠的合作伙伴接洽。
API 门户的游戏名称是为了提高 API 的采用率。在日益数字化的世界中，应用程序之间的通信至关重要。API 使内部和外部受众都能访问您应用程序的服务，并实现您的服务与其系统之间的通信。API 已成为数字企业的中枢神经系统，因为它们允许新的商业模式，例如数据货币化。当今世界都在为创新和增长开辟新的途径，这正是 API 所能实现的，而 API 门户则是吸引用户使用API的途径。
设计 API 门户的最佳方法
API 可以使服务非常易于使用或极其复杂，这可能是使用或不使用 API 的开发人员之间的区别。大多数开发人员（或 API 使用者）发现，在很少甚至没有文档的情况下使用 API 很困难且耗时。在这种情况下，开发人员通常会放弃现有服务，甚至可能会重复功能。为了避免这种挫折感，使用 API 门户的所有功能来简化 API 的使用与设计 API 本身同样重要。
在设计 API 时，首先从受众的需求开始。吸引用户的一个好方法是通过门户网站查看您是否在设计他们所需的内容。API 门户应该像一本手册，可以轻松列出开发人员希望了解的有关 API 的所有内容，以及他们与您互动的地方。 API 消费者利用它来确定您的 API 是否是他们的正确选择。事实上，如果您的组织有带宽，那么 API 目录是为内部和外部受众组织 API 的绝佳方式。
API 目录是一种库，它为您的组织提供了一个查找公司内部所有 API 的地方。不幸的是，大多数情况下，用户必须搜索 API 却不经常找到它们，导致重复工作，更糟糕的是，没有采用您的 API 。API 目录使用户能够更快地找到您的 API。而且，想象一下希望与您的业务集成的外部各方以及是谁在寻找特定 API 。如果没有 API 目录，它们可能会被发送到多个地方，并且通常找不到他们想要的内容。API 目录可以使 API 重复使用并且更容易被发现。API 目录的其他好处包括：
- 集中处理授权
- 综合流量管理
- 一个地方可以监控所有 API，了解 API 使用监控的警报和细节
- 更轻松地注册和登记使用者
API 门户用作创新中心
今天，组织发现 API 门户正在成为创新中心，因为它具有许多可用于交互的功能。许多产品设计和更改都发生在这个特定的交叉点，因为您拥有可以在门户网站上进行沟通的整个团队。
API 门户不仅仅是发布或分发 API 文档的地方。这不需要客户和合作伙伴进行协作，甚至不需要在 API 团队中进行协作。通过使用 API 门户提供的全部功能，如博客、论坛等，您可以鼓励开发人员采用您的 API。
API 网关 vs API 门户
API 网关 是控制您组织中的 API 流量、管理 API 使用情况和负载平衡的方法。这是自动完成的，并且通常不需要太多的人为干预。API 网关更像是后端，但在 API 策略中非常重要。
API 门户是 API 策略的前端。使用者可以在这里注册 API 并获取所有必要信息，例如文档、博客和社区论坛，以确保成功集成、报告反馈和故障或获得更多支持。