跳到主要内容
版本:3.10.x

API 门户

API 门户是集中管理和开放 API 访问的平台。它连接 API 提供商与开发者,并提供 API 文档、规范、代码示例及其他必要信息。

API 门户的另一项关键功能是 API 商业化。企业可以通过该平台实施订阅、按量付费和分级访问等定价模式,根据客户的不同需求设计 API 产品。

除 API 门户的基础功能外,API7 门户(API7 Portal)还面向需要敏捷、精细化 API 管理的企业提供在线调试能力,帮助简化工作流程并加快 API 迭代和部署。

API7 门户作为连接 API 提供商和消费者的中心,在 API7 网关之上提供 API 目录和文档

主要特性

  • 综合开发者中心:提供所有必要的资源,包括 API 文档、指南、规范和代码示例,并支持在线调试。
  • API 商业化工具:支持订阅、按量计费和限流等方式,帮助企业实现 API 商业化。
  • 完整的 API 生命周期管理:支持从设计和开发到部署、监控和弃用的整个 API 生命周期。
  • 数据驱动的洞察:通过高级分析跟踪 API 使用情况、性能和客户行为,为决策和优化提供依据。

用例

API 发现

API7 门户提供集中的 API 展示入口,帮助 API 提供商清晰呈现其 API 和相关服务。开发者可以通过直观的界面浏览 API 目录及每个 API 的详细功能说明,快速了解各 API 的能力及其适用场景。

API 文档

API7 门户为每个 API 端点提供结构清晰的完整文档,包括详细说明、参数、请求和响应格式以及示例。开发者可以据此了解如何将商品列表、支付处理等功能集成到应用中,减少理解成本并缩短上线时间。

API 商业化

假设一家金融服务公司面向企业提供数据分析和交易处理 API。为了维持运营并推动增长,该公司需要将 API 商业化。API7 门户可以提供以下支持:

  • 展示公司的 API 产品并对服务分类
  • 支持各种定价模式,例如分层订阅
  • 根据 API 调用配额实施限流并保障服务质量
  • 集成计费系统以实现无缝支付处理

在线调试

API7 门户与 API7 网关无缝集成,让用户可以轻松发布和管理服务。例如,在 API7 网关中配置名为 GitHub v3 REST API 的服务并通过 API7 门户发布后,开发者可以直接在 API7 门户中测试该服务。借助直观的界面,开发者能够快速发起请求并排查服务问题。

这种集成方式无需使用外部调试工具,降低了操作复杂度,也提高了 API 生命周期管理效率,尤其适合调试或微调服务配置。

API7 门户中的 API 文档页面截图,显示端点参考和 Test Request(测试请求)按钮,开发者可以直接从门户调用端点