接口配置

接口配置支持基于已配置的数据源（数据库 / API），通过SQL 语句 / Groovy 脚本定义数据处理逻辑，生成标准化 API 接口。
接口支持入参 / 出参解析、数据格式转换、缓存、告警、流量控制等高级配置，可快速对外提供数据服务，为前端应用、AI 模型调用、跨系统数据交互提供支撑。

前置条件

1、已完成数据源（MySQL、DB2、PG、API 等）的添加与校验；
2、明确接口业务需求：接口路径、请求方法、入参 / 出参规则、数据处理逻辑（SQL/Groovy）；
3、目标接口路径无重复（平台内接口路径唯一），确保接口调用正常。

1、进入「添加接口配置」页面；

2、选择数据源（下拉选择已配置的数据源）

1、切换到SQL 语句页签，选择执行引擎（默认 SQL 语句，支持 Groovy 脚本）
2、在SQL 语句编辑框中，输入查询逻辑（支持动态参数，用#{参数名}占位）

示例（单表查询）：
SELECT id, name, ri_qi_ AS createTime FROM 211_dataease.area WHERE 1=1
AND (#{name} IS NULL OR name LIKE CONCAT(‘%’, #{name}, ‘%’))

注意：每个SQL窗口中至多写一条SQL语句，支持Mybatis的动态SQL语法。

3、点击解析入参：自动解析 SQL 中的#{}参数，生成入参配置项

4、按需配置入参：

配置项	填写说明	示例
参数名	自动解析 / 手动输入，与 SQL 占位符一致	name
参数位置	参数传递方式：Path（URL 路径）、Query（URL 查询参数）	Query
参数类型	入参数据类型：String、Integer、Date 等	String
数组	是否为数组类型（批量查询场景）	否
必填	入参是否必填（必填则请求缺失会报错）	否
默认值	入参为空时的默认值	空

1、切换到接口配置页签，填写必填基础信息：

配置项	填写说明	示例
名称	接口显示名称，平台内唯一	区域列表查询
接口路径	接口访问 URL（需唯一，支持自定义路径）	/api/areaList
请求方法	下拉选择 HTTP 请求方法：GET/POST/PUT/DELETE	GET
请求类型	接口请求数据格式：application/json、application/x-www-form-urlencoded	application/json
模块	接口所属分组（用于接口分类管理）	默认模块
授权	接口权限分组（控制访问权限）	默认分组
描述	接口用途说明（可选）	同步项目经费表的区域数据

1、切换到其他配置页签，配置出参格式：

配置项	填写说明	示例
命名策略	出参字段命名规则：无转化属性名转换为驼峰命名保属性名转换为蛇形命名属性名转换为小写命名属性名转换为大写命名	属性名转换为驼峰命名
数据格式	不同数据类型的格式化规则：Date/LocalDate：yyyy-MM-dd LocalDateTime/Timestamp：yyyy-MM-dd HH:mm:ss BigDecimal：保留小数位数	6（保留 6 位小数）
系统返回格式配置	是否返回完整 Result 实体（含 code/message/data）	true