跳到主要内容

工作台概览

工作台是接口开发的主入口,集成接口分组、四种开发模式、在线测试、保存发布与最近浏览。

工作台

页面布局​

区域内容
左侧分组树搜索接口、查看分组与子分组、新建分组、编辑分组
顶部页签首页与已打开的接口编辑页,可关闭、切换
首页四种开发模式入口 + 最近浏览
编辑页左侧开发模式面板、中间画布/编辑器、右侧属性面板

四种开发模式​

模式入口适合场景详见
脚本模式使用 SQL 脚本快速开发数据接口需要动态 SQL、批量操作、存储过程SQL 模式
单表模式零代码生成单表 CRUD 接口标准单表查询单表模式
代理模式代理转发第三方接口包装外部 HTTP 服务代理模式
编排模式可视化编排多个接口组合结果多接口聚合与数据处理编排模式
模式切换

接口创建后不建议随意切换执行模式。不同模式的配置结构不同,切换可能导致 SQL、代理参数或编排规则丢失。

接口分组​

左侧分组树按层级管理接口:

  • 分组可以嵌套子分组。
  • 非管理员只能查看自己创建的分组与被授权的分组。
  • 新建分组时可填写分组名称、父级分组与授权邀请。
  • 授权邀请填写指定用户名后,该用户有权查看分组下的 API。
  • 分组下内容为空或接口未发布时,才允许删除分组/接口。

分组与【服务管理 → 分组分类】使用同一套分组数据;分类管理则独立,所有用户都可操作。

最近浏览​

首页下方展示最近编辑与发布的接口:

列说明
接口 ID接口唯一编号
接口名称点击进入编辑页
接口版本当前版本号
分组所属分组
接口类型脚本 / 单表 / 代理 / 编排
创建时间首次创建时间
最近修改时间最近一次保存或发布

点击行可快速回到接口编辑页。

保存与发布​

  1. 保存:保存当前接口定义到 MySQL,生成/更新开发态数据。
  2. 测试:在线验证请求参数与返回结果。
  3. 发布:选择目标环境,生成该环境的发布快照。
  4. 上线:发布后接口进入可调用状态;公开 + 生产环境 + 上线的接口才会进入 API Hub。

限制:

  • 新接口必须先保存,否则发布按钮置灰。
  • 已上线接口不能直接编辑,需先下线(43002)。
  • 发布编排接口时若未配置编排规则,会被拦截(41013)。
  • 接口地址在同一环境下必须唯一,冲突返回 41006。

编辑页右侧面板​

右侧面板通常包含:

面板内容
基本信息名称、地址、方法、权限级别、认证方式、协议、分组、分类、超时、事务、版本
请求参数参数名、类型、位置、必填、示例、描述、校验、分页
返回参数字段名、映射字段、源参数名、类型、描述
数据插件过滤、格式化、字段合并、字段重命名、结果转换(编排模式不含该面板)
Mock / 测试用例模拟响应与回归用例

开发建议​

  1. 先在小数据范围验证 SQL,再发布到生产。
  2. 写操作开启事务,并明确参数校验。
  3. 对外接口优先使用签名认证,避免使用无认证。
  4. 为接口配置测试用例,发布前回归。
  5. 使用分组 + 协作授权控制可见范围,而不是共享账号。

相关阅读​