接口定义

每种开发模式都由「基本信息」「请求参数」「返回参数」三部分共同定义一个接口。开发模式决定接口如何执行，这三部分决定接口长什么样、怎么被调用、返回什么结构。

基本信息

点击工作台右侧「基本信息」打开配置抽屉。

字段	说明	约束
接口编号	保存后由平台生成	只读
接口名称	展示名称，最长 100 字符	必填
接口地址	平台对外路径，前面拼接项目统一前缀	必填；仅英文、数字、`/`、`-`、`_`；不能包含 `//`
请求方式	GET / POST / PUT / PATCH / DELETE	单表模式及 ElasticSearch、Hive 仅 GET
操作类型	查询 / 插入 / 修改 / 删除	单表模式仅查询；Hive 不提供插入
权限级别	公开（所有人可见）/ 私有（仅自己可见）	私有接口不出现在他人可选列表中
认证方式	无认证 / 简单认证（AppKey）/ 签名认证（AppKey + AppSecret）	见下方说明
发布协议	REST 固定勾选；可选 MCP	MCP 仅在简单认证下可选
接口分组	左侧分组树，决定接口归档位置	必填
接口分类	业务分类，用于列表筛选	选填
开启事务	写操作多语句时整体提交/回滚	代理与编排模式不展示
版本号	正整数	必填
超时时间	接口执行超时，单位 ms	代理模式在路由配置中单独设置
描述说明	接口用途、注意事项	选填

签名算法、请求头与验签流程详见签名认证。接口的认证方式只是「允许的认证类型」，真正能调用还需要应用凭证被授权该接口。

右侧「请求参数」定义调用方可以传什么。

字段	说明
参数名	对外暴露的参数名，SQL 中通过 `#{参数名}` 引用
目标参数名	仅代理模式：映射到第三方的参数名，留空默认同名
参数类型	String / Int / Float / Array / Object / Boolean
参数位置	Query / Body / Header；路径参数由 `#{name}` 自动识别
必填	是 / 否
示例值	文档与测试面板的默认示例
默认值	调用方未传时使用
描述	参数含义
子参数	点击 `+` 为 Object / Array 添加嵌套结构

脚本模式支持「解析」：从 SQL 中自动提取 #{} 占位符生成参数，减少手工录入。参数名修改后，SQL 中的引用不会自动重命名，需要同步调整。

查询类 SQL 接口可开启分页：

右侧「返回参数」定义响应字段与结构。

字段	说明
参数名	对外的响应字段名
源字段	SQL 列名 / 脚本字段 / 第三方字段（按模式不同）
参数类型	String / Int / Float / Array / Object / Boolean
位置	代理模式下标识字段位于 `code`、`data`、`msg`、`timestamp`、`traceId` 或其他位置
示例值	文档示例
默认值	字段为空时的回退值
描述	字段含义
子参数	嵌套对象/数组结构

接口默认返回平台统一结构：

{
  "code": 0,
  "msg": "success",
  "data": {},
  "traceId": "..."
}

版本号是接口定义的业务版本，不等同于发布批次。发布记录的对比、回滚与迁移见环境与发布和版本迁移。