操作场景
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 服务发布后的历史情况(最多显示10条)。


查看 API 概览


如图为查看 API 服务的总数统计,可以看到每个项目下的服务总数、每个服务下的 API 明细。

也支持查看项目统计图示,以及单击导入导出项目、服务、API 明细列表。

支持设置关注服务,从而在 API 概览中直接查看其关键指标。

申请及取消订阅
API 目录 展示已上架的 API 服务。类似一个 API 服务市场,上架后的服务,不局限项目维度,可以被当前主账号下的所有子账号查看、订阅并调用。此页面可通过 API 服务的属性快速搜索服务。同时,可申请订阅或取消订阅 API 服务。

申请订阅 API 服务时,需选择或新建订阅凭证。将凭证与 API 服务关联上。待系统管理员审核后,即可成功订阅。

取消订阅后将不能调用该 API 服务,此操作无需系统管理员审核。
查看订阅凭证
订阅凭证用于订阅 API 目录中的服务。凭证即为某 API 服务的钥匙。
在申请订阅 API 服务时将凭证与 API 服务关联上,调用的时候填写该凭证,即可成功调用该服务。同时,能看到该凭证各种鉴权类型的 Key 和 Secret,调用时直接复制即可使用。

一个凭证支持与多个 API 服务关联。可在订阅的 API 中查看此凭证关联的所有 API 服务。

审核管理
审核管理分两个功能:我提交的和我审核的,涉及到审核的事项都在此功能页处理。
我提交的:展示个人提交的所有审核信息,全部角色都可见。在此页面支持查看详情,或撤销申请。


我审核的:此页面展示需审核的信息,只有系统管理员和项目管理员角色能看到,其他角色访问页面数据为空。
在此页面支持查看详情,通过审核或驳回审核。


说明:
系统管理员审批全部项目 API 服务上下架或 API 服务订阅的请求。
项目管理员审批所在项目内的 API 服务上下架或 API 服务订阅的请求。
规范管理
支持系统管理员对全部 API 接口按所选检查策略进行规范检查,得出每一个 API 接口的检查明细、得分,并支持导出检查报告 Excel 文件,以作进一步分析。
规范配置:系统默认提供一个“默认策略”,其中包括针对请求路径、请求方法、鉴权方式、请求参数、后端资源路径的规范检查项配置。


系统默认会给所有 API 服务,都关联默认检查策略。


规范检查:进入规范检查菜单,可以按指引启动规范检查,检查结束后可以查看检查列表,呈现每个 API 接口对应的待修正检查项,检查结果,结果分值。


支持单击待修正检查项,查看详细的不规范项内容;


单击右上角导出检查报告,设置检查结果分档。
