测试文档(产品帮助文档专用)

其他操作@

接口服务管理支持的其他操作有:新建分组、查看、编辑、删除、测试、申请发布、申请变更、撤回申请、导入导出、移动、克隆、安全配置、查看历史版本等。

1. 新建分组

点击新建分组按钮,进行创建分组。建立分组方便对接口进行管理。

已存在的分组,还支持点击操作栏的按钮进行编辑、删除、移动。

2. 查看API详情

点击接口标题可查看API详情信息。

详情信息包括API接口的基本信息、服务配置、请求参数、请求示例、响应信息、返回示例、调用示例、管理信息、加密策略。

3. 编辑API

用户可对“已退回”和“草稿”状态的API进行编辑,编辑后可重新发布。

4. 删除API

用户可对“已退回”和“草稿”状态的API进行删除操作。

5. 测试API

用户可点击测试对API进行测试。

6. 申请发布

API只有发布成功并上架后才能被使用和被调用。

用户可对“已退回”和“草稿”状态的API进行申请发布操作。若发布绑定工作流,申请发布后,API状态变成“审批中”。相关人员审批通过后变成“已发布”状态,审批不通过则变成“已退回”状态。若未绑定工作流,申请发布后,API状态变成“已发布”。

7. 申请变更

若需要编辑或删除已发布的API,可以点击操作栏的“申请变更”按钮;或者勾选多个已发布的接口,点击列表上方的“申请变更”按钮,进行批量操作。

8. 撤回申请

用户可对申请发布/变更后状态为“审批中”的API进行撤回申请操作。

9. 导入导出接口

若需要将已创建的接口迁移到其他环境,可使用导入导出功能。

点击导出,会将已勾选的接口进行导出;点击导出全部,会导出所有分组和接口。

导出进度框,点击下载,会下载为zip格式的压缩包。

在新环境点击导入,选择上面下载的zip文件上传,即可将接口迁移到新环境。

10. 导出API详情

若需要将接口以文档形式提供给第三方,可以使用导出API详情。下载的接口文档格式为PDF。

11. 移动 

点击操作栏的移动按钮,选择目标分组,可将接口或分组移动到其他分组的下级,便于管理。

12. 克隆

若需要新建配置类似的接口,可以使用克隆功能,快速创建一个配置相同的接口,再对有区别的配置进行编辑。

 

13. 安全配置

用户可对API进行安全设置。设置API的访问超时时间、访问频率、黑名单、免登陆名单等。也可以在【系统设置】-【参数设置】中进行【全局安全配置】。

安全配置优先级:服务授权管理>接口安全配置>全局安全配置

14. 查看历史版本

发布接口成功后,会增加一个历史版本。支持查看各历史版本的详情。

 还可以进行版本对比,方便找到接口配置的修改之处。

若需要回退到旧版本的配置,可使用恢复功能,恢复后接口变成草稿状态,需要重新发布。

附件列表

0

文档内容仅供参考
如果您需要解决具体问题,还可以登录亿信社区
在提问求助板块提问,30分钟内帮您解决问题

如果您认为本词条还有待完善,请编辑

上一篇基于第三方服务创建接口

下一篇接口上下架

请先登录