API目录审批
目录
一、功能概述
API 注册审批,是对 API 注册到 API 目录的申请进行严格审批的关键流程,旨在确保只有符合标准的 API 才能接入系统。在 TUS 系统中,统一采用 “注册审批” 这一名称(部分系统也称为 “发布审批”,但两者不可同时存在,名称确定即概念明确)。
ESB平台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注册信息的审批退回操作。

(1)查看API详情
点击API注册列表中“API名称”列,查看API注册的详细信息。

(2)执行审批通过操作
点击API注册列表中“操作”列的“通过”按钮,并在弹出的“确认要通过xx的审批吗”提示框中点击确认按钮,执行API注册的审批通过操作。
API注册审批通过以后,在“资源管理器->API集成”API的管理页签中点击“部署”,在注册成功的面板,可查看该API信息的“是否已发布”列为“已发布”状态。
(3)执行审批退回操作
点击API注册列表中“操作”列的“退回”按钮,并在弹出的“确认要退回xx的审批吗”提示框中点击确认按钮,执行API注册的审批退回操作。
API注册审批退回以后,在注册失败的面板,可查看该API信息的“目录状态”列为“已退回”状态。
已退回状态的API信息,用户修改后可以继续注册,变为变更待审批状态,等待再次审批,用户也可将审批退回的API信息撤销注册。
(三)注册成功页面
操作步骤: 在运维中心左侧菜单栏中,找到并点击“审批管理->API目录审批”菜单,点击“注册成功”页签,打开注册成功的API信息列表页面,该页面显示注册审批通过的API信息。

当前页面可执行的操作包括:查看API详情、测试API、查看URL、撤销注册等操作
-
API详情:点击某行API信息的“API名称”列,可执行API注册信息的审核通过操作。
-
测试:点击某行API信息操作列的“测试”按钮,可执行API测测试操作。
-
URL:点击某行API信息操作列的“URL”按钮,可查看API信息的调用URL。
-
撤销注册:点击某行API信息操作列的“撤销”按钮,可执行API的撤销注册操作。
(1)API详情
点击API注册成功列表中“API名称”列,查看API注册的详细信息。
(2)测试
点击API注册成功列表中“操作”列,点击测试按钮,可以执行该API测调用测试操作,确保发布后的API在以后的流程中可使用。
(3)URL
点击API注册成功列表中“操作”列,点击URL按钮,可以查看该API被调用时所使用的URL地址信息,调用者通过它可以对该API执行调用操作。
(4)撤销注册
某个API不在允许被别人使用时,我们在API注册成功列表中“操作”列,点击撤销注册按钮,可以执行该API测撤销注册操作。
注意:执行API的撤销注册操作时,需要该API信息处于停滞状态,非停止状态的api需要到API运行管理界面执行API的停止操作之后,方可继续执行撤销注册操作。
(四)注册失败页面
操作步骤: 在运维中心左侧菜单栏中,找到并点击“审批管理->API目录审批”菜单,点击“注册失败”页签,打开注册失败的API信息列表,该页面显示注册审批退回的API信息。

当前页面展示API注册审批,被退回的API信息。
(1)查看API详情
点击API信息列表中“API名称”列,查看API的详细信息。
(五)进入变更待审批页面
操作步骤: 在运维中心左侧菜单栏中,找到并点击“审批管理->API目录审批”菜单,点击“变更待审批”页签,打开变更待审批的API列表页面,该页面显示变更待审批的API信息列表。
当前页面可执行的操作包括:查看API详情、通过、退回
-
API详情:点击某行API信息的“API名称”列,可执行API变更信息的审批通过操作。
-
通过:点击某行API信息操作列的“通过”按钮,可执行API变更信息的审批通过操作。
-
退回:点击某行API信息操作列的“退回”按钮,可执行API变更信息的审批退回操作。

(1)查看API详情
点击API信息列表中“API名称”列,查看变更后的API详细信息。
(2)执行变更审批通过操作
点击API信息列表中“操作”列的“通过”按钮,并在弹出的“确认要通过xx的审批吗”提示框中点击确认按钮,执行API变更的审批通过操作。
(3)执行变更审批退回操作
点击API变更列表中“操作”列的“退回”按钮,并在弹出的“确认要退回xx的审批吗”提示框中点击确认按钮,执行API变更的审批退回操作。
(六)撤销待审批页面
操作步骤: 在运维中心左侧菜单栏中,找到并点击“审批管理->API目录审批”菜单,点击“撤销待审批”页签,打开撤销待审批的API列表页面,该页面显示撤销待审批的API信息列表。
当前页面可执行的操作包括:查看API详情、通过、退回
-
API详情:点击某行API信息的“API名称”列,可执行API信息的撤销审批通过操作。
-
通过:点击某行API信息操作列的“通过”按钮,可执行API信息的撤销审批通过操作。
-
退回:点击某行API信息操作列的“退回”按钮,可执行API信息的撤销审批退回操作。

(1)查看API详情
点击API信息列表中“API名称”列,查看待撤销审批的API详细信息。
(2)执行变更审批通过操作
点击API信息列表中“操作”列的“通过”按钮,并在弹出的“确认要通过xx的审批吗”提示框中点击确认按钮,执行API撤销的审批通过操作。
(3)执行变更审批退回操作
点击API变更列表中“操作”列的“退回”按钮,并在弹出的“确认要退回xx的审批吗”提示框中点击确认按钮,执行API撤销的审批退回操作。
(七)已撤销页面
操作步骤: 在运维中心左侧菜单栏中,找到并点击“审批管理->API目录审批”菜单,点击“已撤销”页签,打开撤销注册审核通过的API信息列表,该页面显示撤销注册并审核通过的API信息。

(1)查看API详情
点击API信息列表中“API名称”列,查看已撤销的API详细信息。
三、常见问题解答
(一)什么是 API 注册审批?
API 注册审批是对 API 注册到API目录的申请进行审核的过程,确保只有符合要求的 API 能够接入系统。 也有的系统称为"发布审批"(对 API 发布到API目录的申请进行审核的过程)。 总之,“审批”要么称为注册审批、要么称为发布审批,不能同时存在。审批的名称确定了,概念本身就确定了。 在TUS中,统一称为“注册审批”。
(二) 如何切换不同状态的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 的使用情况,及时优化配置。