Skip to content
Datablau DAM数据治理产品手册
数据服务 模块手册下载 PDF

API 开发与发布 ​

“我开发的 API”用于创建和维护本人负责的接口;“管理 API”供管理员查看已上线接口、授权用户及访问监控。设计接口时先明确数据来源、使用场景、请求参数、响应字段和访问边界。

创建 API ​

  1. 进入“数据服务 → 我开发的 API”,选择“添加”。
  2. 按表单填写 API 配置信息,明确接口用途、请求参数和返回数据。
  3. 保存后打开详情,核对配置是否与预期数据来源一致。
  4. 使用受控参数执行测试,检查正常结果、空结果和错误输入的处理。

API 配置字段和鉴权方式应按所部署环境的表单及接口规范填写,不使用其他环境的地址、参数或凭据。

测试与发布 ​

在 API 详情选择“测试”。页面提示测试成功后,仍需核对返回数据是否符合业务定义;提示失败时检查请求参数、数据来源、权限和服务状态。测试通过的 API 才能发布到 API 市场。发布后到市场重新打开详情,核对调用者所看到的参数与返回说明。

修改、下线和删除 ​

编辑已上线 API 前,先检查是否需要下线;编辑后重新测试并发布。已被申请的 API 可能受下线限制,应先确认授权和调用影响。删除前也应检查上线状态及依赖应用。

变更接口契约前记录受影响的应用和调用方。下线、编辑或删除都应先检查访问监控与业务通知,不应只根据列表按钮是否可点判断影响范围。

管理员检查 ​

管理员在“管理 API”中打开接口详情,查看基本信息、授权用户和访问监控。管理员也可测试和下线已上线接口。执行下线前检查现有申请,测试后还要核对真实调用链路;管理页测试成功不能替代调用方验收。

相关文档 ​