接口设计（应用 API 设计器）完整指南
接口设计（应用 API 设计器）是 DSP 平台核心模块之一，提供与业务对应的配置、设计或运维能力。下文按界面区域说明入口、分步操作与注意事项。 典型场景： 表单数据源
接口设计（应用 API 设计器）是 DSP 平台核心模块之一，提供与业务对应的配置、设计或运维能力。下文按界面区域说明入口、分步操作与注意事项。 典型场景： 表单数据源 完成本页后，你应能够理解功能边界，并按步骤完成配置和验证。
开始前检查
- 已登录 DSP 平台并进入正确组织
- 已选择目标应用和当前开发版本
- 账号拥有当前功能的查看或编辑权限
概述
接口设计（应用 API 设计器）是 DSP 平台核心模块之一，提供与业务对应的配置、设计或运维能力。下文按界面区域说明入口、分步操作与注意事项。
典型场景：
- 表单数据源
入口与使用前准备
访问入口
| 入口 | 路径 |
|---|---|
| 设计器 | /dsp/api/:appCode/design |
| 单接口 | /dsp/api/:appCode/design/:apiId |
使用前准备
应用已创建。
界面总览
功能分节
接口清单
功能说明：应用内 API 列表与调试。
操作步骤：
- 新建 API
- 配置入参出参
- 调试
- 保存
注意事项：与 API 集成中心平台级资产不同。
高级配置
功能说明：高级配置相关能力，详见界面实际 Tab/按钮。
操作步骤：
- 打开对应 Tab 或菜单
- 按界面提示完成配置
- 保存并验证
预期结果：无报错且列表/画布数据刷新。
运维监控
功能说明：运维监控相关能力，详见界面实际 Tab/按钮。
操作步骤：
- 打开对应 Tab 或菜单
- 按界面提示完成配置
- 保存并验证
预期结果：无报错且列表/画布数据刷新。
与其他模块联调
功能说明：与其他模块联调相关能力，详见界面实际 Tab/按钮。
操作步骤：
- 打开对应 Tab 或菜单
- 按界面提示完成配置
- 保存并验证
预期结果：无报错且列表/画布数据刷新。
端到端场景
场景 A：表单数据源
定义查询 API→页面数据绑定
权限与可见性
开发权限。
字段与控件说明
字段名称以当前页面显示为准。不同版本或权限下，可选项可能有所差异。
| 字段名称 | 位置 | 用途 | 填写规则 | 可选值 | 影响结果 | 常见错误 |
|---|---|---|---|---|---|---|
| 设计器 | 入口 | 打开 /dsp/api/:appCode/design | 按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举；按业务规则或页面格式要求填写。 | 打开 /dsp/api/:appCode/design | 若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。 |
| 单接口 | 入口 | 打开 /dsp/api/:appCode/design/:apiId | 按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举；按业务规则或页面格式要求填写。 | 会影响外部系统调用、数据同步或联调排查。 | 若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。 |
| 新增 | 接口清单 | 打开新建弹窗或向导 | 按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举；按业务规则或页面格式要求填写。 | 打开新建弹窗或向导 | 若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。 |
| 保存 | 接口清单 | 持久化配置 | 按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举；按业务规则或页面格式要求填写。 | 持久化配置 | 若无法保存，优先检查必填项、格式校验、权限和网络请求返回信息。 |
| 接口清单 | 接口清单 | 应用内 API 列表与调试。 | 按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举；按业务规则或页面格式要求填写。 | 会影响外部系统调用、数据同步或联调排查。 | 若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。 |
| 保存 | 高级配置 | 持久化配置 | 按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举；按业务规则或页面格式要求填写。 | 持久化配置 | 若无法保存，优先检查必填项、格式校验、权限和网络请求返回信息。 |
| 高级配置 | 高级配置 | 高级配置相关能力，详见界面实际 Tab/按钮。 | 按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举；按业务规则或页面格式要求填写。 | 高级配置相关能力，详见界面实际 Tab/按钮。 | 若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。 |
| 保存 | 运维监控 | 持久化配置 | 按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举；按业务规则或页面格式要求填写。 | 持久化配置 | 若无法保存，优先检查必填项、格式校验、权限和网络请求返回信息。 |
| 运维监控 | 运维监控 | 运维监控相关能力，详见界面实际 Tab/按钮。 | 按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举；按业务规则或页面格式要求填写。 | 运维监控相关能力，详见界面实际 Tab/按钮。 | 若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。 |
| 保存 | 与其他模块联调 | 持久化配置 | 按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举；按业务规则或页面格式要求填写。 | 持久化配置 | 若无法保存，优先检查必填项、格式校验、权限和网络请求返回信息。 |
| 与其他模块联调 | 与其他模块联调 | 与其他模块联调相关能力，详见界面实际 Tab/按钮。 | 按页面提示填写或选择，保存前检查必填项、格式和关联数据是否完整。 | 无固定枚举；按业务规则或页面格式要求填写。 | 与其他模块联调相关能力，详见界面实际 Tab/按钮。 | 若操作无响应，刷新页面后重试，并检查当前账号是否具备该模块操作权限。 |
完成标准
不要只以“按钮点击成功”作为完成依据，请至少核对以下结果。
- 打开 /dsp/api/:appCode/design
- 打开 /dsp/api/:appCode/design/:apiId
- 打开新建弹窗或向导
- 表单数据源
- 保存或提交后页面没有错误提示，刷新后配置仍可正确回显。
常见问题
Q1：调试 401
现象调试 401。
原因见处理步骤。
处理Token 与 Header
Q2：与集成中心区别
现象与集成中心区别。
原因见处理步骤。
处理本工具面向单应用脚本 API
Q3：页面白屏或路由 404
现象页面白屏或路由 404。
原因见处理步骤。
处理检查 /dsp 前缀与路径参数；重新登录。
Q4：无权限 403
现象无权限 403。
原因见处理步骤。
处理权限管理分配角色资源后重新登录。
Q5：保存或提交失败
现象保存或提交失败。
原因见处理步骤。
处理F12 查看接口 message；补全必填项。
Q6：列表无数据
现象列表无数据。
原因见处理步骤。
处理确认后端服务与租户；点击刷新。
Q7：菜单无入口
现象菜单无入口。
原因见处理步骤。
处理getMyMenuTree 资源配置。
截图与文档不一致
处理检查前置条件、权限与当前配置，修正后重新执行。