操作指南稳定能力

接口设计(应用 API 设计器):功能分节

了解 接口设计(应用 API 设计器) 中“功能分节”的使用方法、操作要求和完成标准。

阅读本页后,你可以

了解 接口设计(应用 API 设计器) 中“功能分节”的使用方法、操作要求和完成标准。 完成本页后,你应能够理解功能边界,并按步骤完成配置和验证。

开始前检查

  • 已登录 DSP 平台并进入正确组织
  • 已选择目标应用和当前开发版本
  • 账号拥有当前功能的查看或编辑权限
功能分节界面示例
功能分节界面示例,点击可查看原图。

功能分节

接口清单

功能说明:应用内 API 列表与调试。

图4-1 接口清单
图4-1 接口清单

操作步骤:

  1. 新建 API
  2. 配置入参出参
  3. 调试
  4. 保存

注意事项:与 API 集成中心平台级资产不同。

高级配置

功能说明:高级配置相关能力,详见界面实际 Tab/按钮。

图4-2 高级配置
图4-2 高级配置

操作步骤:

  1. 打开对应 Tab 或菜单
  2. 按界面提示完成配置
  3. 保存并验证

预期结果:无报错且列表/画布数据刷新。

运维监控

功能说明:运维监控相关能力,详见界面实际 Tab/按钮。

图4-3 运维监控
图4-3 运维监控

操作步骤:

  1. 打开对应 Tab 或菜单
  2. 按界面提示完成配置
  3. 保存并验证

预期结果:无报错且列表/画布数据刷新。

与其他模块联调

功能说明:与其他模块联调相关能力,详见界面实际 Tab/按钮。

图4-4 与其他模块联调
图4-4 与其他模块联调

操作步骤:

  1. 打开对应 Tab 或菜单
  2. 按界面提示完成配置
  3. 保存并验证

预期结果:无报错且列表/画布数据刷新。

字段与控件说明

字段名称以当前页面显示为准。不同版本或权限下,可选项可能有所差异。

9 项
字段名称位置用途填写规则可选值影响结果常见错误
新增接口清单打开新建弹窗或向导按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。打开新建弹窗或向导若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
保存接口清单持久化配置按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。持久化配置若无法保存,优先检查必填项、格式校验、权限和网络请求返回信息。
接口清单接口清单应用内 API 列表与调试。按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。会影响外部系统调用、数据同步或联调排查。若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
保存高级配置持久化配置按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。持久化配置若无法保存,优先检查必填项、格式校验、权限和网络请求返回信息。
高级配置高级配置高级配置相关能力,详见界面实际 Tab/按钮。按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。高级配置相关能力,详见界面实际 Tab/按钮。若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
保存运维监控持久化配置按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。持久化配置若无法保存,优先检查必填项、格式校验、权限和网络请求返回信息。
运维监控运维监控运维监控相关能力,详见界面实际 Tab/按钮。按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。运维监控相关能力,详见界面实际 Tab/按钮。若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。
保存与其他模块联调持久化配置按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。持久化配置若无法保存,优先检查必填项、格式校验、权限和网络请求返回信息。
与其他模块联调与其他模块联调与其他模块联调相关能力,详见界面实际 Tab/按钮。按页面提示填写或选择,保存前检查必填项、格式和关联数据是否完整。无固定枚举;按业务规则或页面格式要求填写。与其他模块联调相关能力,详见界面实际 Tab/按钮。若操作无响应,刷新页面后重试,并检查当前账号是否具备该模块操作权限。

完成标准

不要只以“按钮点击成功”作为完成依据,请至少核对以下结果。

  • 打开新建弹窗或向导
  • 持久化配置
  • 应用内 API 列表与调试。
  • 表单数据源
  • 保存或提交后页面没有错误提示,刷新后配置仍可正确回显。

继续阅读