1.概述
【资产API管理】模块用于查看和管理用户在平台通过数据资产批量生成或单个生成的API,支持的操作有:查看、编辑、删除、测试、发布、下架,以及安全配置等。
2.管理资产API
2.1查看API
在资产API列表中点击具体API可查看API详情信息。
详情信息包括API接口的基本信息、服务配置、请求参数、请求示例、响应信息、返回示例、调用示例、管理信息。
2.2编辑API
用户可对“已退回”(API发布时若审批不通过则变成已退回状态)和“草稿”(API下架后变成草稿态)状态的API进行重新编辑,编辑后可重新申请发布。
2.3删除API
用户可对“已退回”和“草稿”状态的API进行删除操作。
2.4测试API
用户可点击测试对API进行测试。
这里的API都是本地接口,用于查询资产数据,测试时需输入请求体。在该API的详情信息页面有请求体示例。
在测试页面输入请求体,然后点击查询,在响应数据区域即可看到返回数据。
2.5申请发布API
API只有申请发布且审批通过变成“已发布”状态后才能被使用和被调用。
用户可对“已退回”和“草稿”状态的API进行申请发布操作。申请发布后,API状态变成“审批中”。相关人员审批通过后变成“已发布”状态,审批不通过则变成“已退回”状态。如何审批API见接口发布审批章节。
已发布的API可在【数据资产】-【数据资源】-【资源挂接】-【绑定API】界面进行资源API绑定,用户可在资产门户中查看绑定的API,并申请调用。
2.6撤回申请API
用户可对申请发布后状态为“审批中”的API进行撤回申请操作。
2.7下架API
对于已发布的API,如果需要修改API或者取消API服务使其不可用,可下架该API。
用户可对已发布的API进行下架操作,下架后变成“草稿”状态,编辑后可重新申请发布。
2.8安全配置
用户可对API进行安全设置。设置API的访问超时时间、访问频率、黑名单、免登陆名单等。
请先登录