API7 企业版 v3.3.0 全面支持开发者门户,让 API 使用更便捷

更新时间 12/26/2024

开发者门户是指面向 API 使用方(如第三方开发者、内部团队等)提供的统一接口文档、测试工具及相关资源的专用平台。它不仅能帮助开发者快速了解与集成 API,同时也在管理与安全层面为平台提供了更好的可视化与控制手段。对于一个网关平台而言,提供开发者门户能够:

  1. 快速对外开放 API:将以往零散的文档、示例、接口说明整合到一个统一入口,极大降低了对接成本,加速产品的对外集成进程。
  2. 提高研发与运维效率:通过自助化的文档查询、测试和调试功能,减少重复沟通与文档维护,提升整体效率。
  3. 统一管理与监控:平台可更好地追踪各方访问、分析响应情况,并及时掌握接口使用的关键指标与潜在问题。

在 API7 企业版 3.3.0 版本中,我们的 API 网关平台现已实现了从用户的 API 文档直接生成开发者门户的能力,让企业能够更轻松地将 API 资源对外开放,并为开发者提供便捷、一致的使用体验。

API7 门户管理端(Provider Portal)和开发者门户(Develoepr Portal)

在 API 管理平台的生态里,API7 门户管理端和开发者门户是相辅相成、但服务对象和功能划分不同的两个重要门户:

API7 门户管理端

API7 门户管理端是为 API 提供者提供更易于配置和监控的管理后台,帮助其更好地管理 API 生命周期。

  • 主要面向 API 提供者和管理者
  • 核心功能包括:
    • API 产品的发布、管理;
    • 开发者的管理;
    • 管理开发者门户对外开放的策略,如匿名查看 API 产品,登录方式的配置;
    • 可视化查看 API 访问情况、统计分析和日志追踪。

开发者门户

开发者门户是为开发者或合作方提供统一的、自助式的入口,帮助其快速了解、接入并使用 API 服务。

  • 主要面向 API 使用方(如第三方开发者、合作伙伴或企业内部开发团队)
  • 核心功能包括:
    • 提供 API 文档、使用指南、示例代码;
    • 在线测试和调试界面;
    • 应用注册、API Key 获得、调用凭证管理等。

功能使用

API7 门户管理端入口

登录 API7 企业版控制台后,系统默认进入网关管理页面。若需进入 API7 门户管理端,可点击左上角的切换按钮。切换至 API7 门户管理端后,页面标题将变为 API7 Provider Portal,左侧菜单项也会随之更新,此时即可进行 API 产品管理。

API7 Provider Portal

创建并发布 API 产品

API 产品是 API7 门户管理端中的核心资源,代表一组业务相关的 API。开发者在订阅时,通常以 API 产品为单位进行订阅。创建 API 产品有以下两种方式:

1. 基于 API7 网关已发布服务创建

  • 从 API7 网关中选择已发布的服务,并将其组合成一个 API 产品。
  • 在 API 产品中,每个服务对应的路由会被视为一个独立的 API。

2. 导入 OpenAPI 文件创建

  • 通过导入现有的 OpenAPI 文件,快速生成 API 产品。
  • 此方式创建的 API 产品暂时与网关侧无联动关系。

基于 API7 网关已发布服务为例,点击“从 API7 网关创建”按钮,即可进入添加 API 产品的表单页面。

Add API Product

在添加 API 产品的表单中,需要填写以下信息:

  1. 基础信息:包括名称、描述、标签、Logo 等。

  2. 认证方式:指定是否需要审批。

  3. 可见性配置:设置 API 产品的可见范围。

  4. 关联的网关服务:选择已发布的网关服务,需满足以下两个条件:

    • 已配置主机名字段。
    • 已上传 OpenAPI 文档。

如果当前没有符合条件的服务,可按照以下流程进行配置。

1. 为已有的服务上传 OpenAPI 文档和配置主机名

Configure OpenAPI Specification

在服务详情或服务模板页面,点击左侧导航栏中的 "OpenAPI 规范" 选项,然后通过上传按钮选择与服务对应的 OpenAPI 规范文档。请注意,文档中的 API 定义必须与服务的实际路由完全匹配,这样才能确保开发者在调试时能够获取到准确的 API 文档,并成功访问上游服务。

Upload OpenAPI Specification

上传 OpenAPI 规范文档后,你可以在页面中实时预览文档效果,该预览与开发者最终访问的 API 文档是一致的。

View OpenAPI Specification

在已发布服务详情页面或服务模板详情页面中,选择左侧路由菜单,在请求 URL 模块中我们可以进行主机名的配置,默认为“*”,即当前服务对任意主机名的请求都会处理并转发。

Request URL

这里我们必须指定一个精确的主机名才能将当前服务用于关联 API 产品。之所以有这个要求,是因为开发者在开发者门户进行调试时,需要通过“主机名+路径前缀+API”路径的方式进行请求的调用,因此需要一个具体的主机名才能将访问 API 的完整路径告知开发者。

2. 创建新的服务用于关联 API 产品

Add Service

如果你当前尚未发布任何服务,可以通过上传 OpenAPI 规范文档直接创建服务模板并发布,或者在网关组中直接创建已发布的服务。通过这种方式创建的服务会自动将 OpenAPI 规范文档中的 API 解析为路由,同时文档也会被直接保留,无需再次上传。按照前面提到的步骤配置主机名后,该服务即可用于关联 API 产品。

在网关完成配置后,返回门户并点击“添加关联的网关服务”,选择需要的已发布服务即可完成关联。

Add Linked Gateway Service

API 产品创建后默认为草稿(Draft)状态,开发者不可见。此时应检查 API 文档、可见性配置和认证方式。建议配置 API 产品事件通知,例如订阅审批(包括通过/拒绝)和取消订阅等事件的邮件通知,以防遗漏重要信息。

发布 API 产品

确认 API 产品无误后,点击页面右上角的“发布”按钮并二次确认,符合可见性设置的开发者即可在开发者门户中访问该 API 产品。

Publish API Product

进入开发者门户

访问开发者门户有两种方式:

  1. 直接访问开发者门户的 URL。
  2. 在 API7 门户管理端的左侧菜单栏中点击“开发者门户”按钮。
Enter Developer Portal

在开发者门户首页,点击右上角的“登录”按钮即可登录。

Login to Developer Portal

创建开发者

创建开发者账户有两种方式:用户自助注册和管理员手动添加。

  • 用户自助注册: 在开发者门户登录页面,点击“注册”按钮,填写用户名和密码即可完成注册。
  • 管理员手动添加: 管理员可通过API7 门户管理端为用户创建账户。

用户自行注册

在登录页面点击注册按钮,在注册页面中填写用户名并输入密码即可注册成功。

Developer Sign up

管理员手动添加开发者

在 API7 门户管理端中,左侧菜单选择开发者,在列表右上角点击邀请开发者,在表单中填写新账号的用户名,一次性密码,也可以为开发者指定一个名称用于标识用户,点击邀请按钮即可添加开发者。

Invite Developer

开发者添加完成后,将用户名与一次性密码告知实际需要登录的用户,在开发者门户登录后需要进行密码重置,重置后既可正常登录开发者门户。

Reset Password

查看 API 产品

开发者登录成功后,点击顶部栏中的 API Hub 即可查看所有已发布的 API 产品。

View API Products

点击 API 产品卡片进入 API 产品详情页。

View API Product Details

在 API 详情页面,除提供 API 文档查阅功能外,系统还支持为每个 API 生成多语言的调用代码示例。开发者可将这些示例代码复制到其开发环境进行测试。

调试 API 产品

除了复制 API 调用代码示例,我们也可以直接点击 Test Request 进行在线调试。

Test API Products

点击 Test Request 后,会弹出一个在线调试面板。其中:

  • 请求 URL 已根据 API 产品关联的服务配置自动生成。
  • 认证方式默认为 Key Auth,并自动填充当前开发者账户的 API Key。

开发者仅需根据 API 接口定义,补充必要的请求参数即可进行调试。

Modify Parameters and Test API Products

订阅 API 产品

如果 API 产品只提供给指定用户进行调用,提供商管理员可以在 API 产品的可见性配置中,将未订阅的开发者可以查看 API 详情开关关闭,这样就要求开发者订阅后才能进行 API 的查看和调用。

Edit Visibility of API Products

此时开发者进入 API 产品详情页会展示一个订阅以解锁的按钮,点击后会向提供商管理员发送订阅请求。

Subscribe to Unlock

如果当前产品还开启了审批流程,那么开发者需要等待管理员通过审批后才能查看详情。

Waiting for Approval

在 API7 门户管理端的组织菜单中,如果存在待处理的审批,审批菜单项后面会有一个红点进行提示,点击菜单项进入审批页面。

Approvals under Organization

审批页面用于管理开发者对 API 资源的访问申请。管理员可在该页面审查以下申请信息:事件类型、资源名称、申请人以及申请时间。管理员可通过操作界面执行“批准”或“拒绝”操作。

审批结果将直接影响开发者的 API 访问权限:

  • 批准:开发者获得访问 API 产品详情页及调用 API 的权限。
  • 拒绝:开发者需与管理员沟通,根据管理员的反馈进行必要的调整后,重新提交申请。

Pending Approvals

总结

API7 企业版通过整合 API 网关平台与开发者门户的功能,为 API 提供者和开发者共同搭建了一个高效 API 管理平台。API7 门户管理端为 API 提供者能够方便地发布、管理和监控 API 产品,同时有效协调开发者资源。相应地,开发者可以快速了解、接入和有效利用 API 服务,从而加快应用开发速度。这两个门户协同工作,促进了 API 生命周期管理流程的简化,从部署到调用,每一步都变得更加顺畅高效。

微信咨询

获取方案