芋道-低代码

Appearance

API 定义 ​

symbol, apiName, apiCode说明 ​

symbol字段说明 ​

符号描述
NONE无（不进行任何条件匹配）
LLIKE左模糊匹配（如 %关键词）
RLIKE右模糊匹配（如 关键词%）
LIKE模糊匹配（如 %关键词%）
NOTLIKE不匹配（模糊）
EQ等于
NE不等于
GE大于等于
GT大于
LE小于等于
LT小于
IN在列表中
NOTIN不在列表中
BETWEEN介于...之间（范围查询）
ISNULL为 NULL
NOTNULL不为 NULL
JSON_CONTAINSJSON 字段包含指定内容

💡 小贴士：

  • LLIKE/RLIKE 适用于需要精确控制模糊匹配方向的场景（如搜索时关键词在开头/结尾）
  • JSON_CONTAINS 用于操作 JSON 类型字段，例如 {"tags": ["java", "spring"]} 中的 tags 字段包含 spring

apiName 说明 ​

apiName 为 查询器部署时指定的接口名称, 查询时如未指定接口编码则默认使用最新部署的配置版本。

apiCode 说明 ​

apiCode 查询器部署时自动生成的接口编码, 查询时用于指定使用特定的配置版本。

selectPage 分页查询接口 ​

管理后台-接口地址： /admin-api/lowcode/deploy-api/{apiName}/select-page

用户端-接口地址： /app-api/lowcode/deploy-api/{apiName}/select-page

请求方式： POST

接口描述： 根据查询配置，执行分页查询

请求参数：

参数名称参数说明请求类型是否必须
apiName接口名称路径参数是
apiCode接口编码查询参数否
queryDomainParams请求参数请求体是
 pageParams分页参数是
  pageNo页码，从 1 开始是
  pageSize每页条数是
  sortingFields排序参数否
   field排序字段否
   orderasc desc否
 whereParams查询参数否
  name查询字段名是
  symbol查询符号类型是
  value查询值（取决于 symbol 类型）取决于 symbol
  values查询值数组（取决于 symbol 类型）取决于 symbol

💡 使用提示

  • symbol 的值需匹配 QueryDomainSymbolType 枚举（如 EQ/LIKE/BETWEEN）
  • value 和 values 的实际值类型由 symbol 决定（例如 BETWEEN 需传入数组 [min, max]，IN 需传入列表）

响应参数：

参数名称参数说明类型
code状态码Integer
msg返回信息String
data返回数据PageResul
 total数据总量Integer
 list数据列表List

请求示例：

json
{
  "pageParams": {
    "pageNo": 1,
    "pageSize": 10,
    "sortingFields": [
      {
        "field": "",
        "order": ""
      }
    ]
  },
  "whereParams": [
    {
      "name": "",
      "symbol": "",
      "value": {},
      "values": []
    }
  ]
}

响应示例：

javascript
{
	"code": 0,
	"msg": "",
	"data": {
		"total": 0,
		"list": []
	}
}

selectOne 单条查询接口 ​

管理后台-接口地址： /admin-api/lowcode/deploy-api/{apiName}/select-one

用户端-接口地址： /app-api/lowcode/deploy-api/{apiName}/select-one

请求方式： POST

接口描述： 根据查询配置，执行单条数据查询

请求参数：

参数名称参数说明请求类型是否必须
apiName接口名称路径参数是
apiCode接口编码查询参数否
queryDomainParams请求参数请求体是
 whereParams查询参数否
  name查询字段名是
  symbol查询符号类型是
  value查询值（取决于 symbol 类型）取决于 symbol
  values查询值数组（取决于 symbol 类型）取决于 symbol

💡 使用提示

  • symbol 的值需匹配 QueryDomainSymbolType 枚举（如 EQ/LIKE/BETWEEN）
  • value 和 values 的实际值类型由 symbol 决定（例如 BETWEEN 需传入数组 [min, max]，IN 需传入列表）
  • 仅返回一条数据

响应参数：

参数名称参数说明类型
code状态码Integer
msg返回信息String
data返回数据Object

请求示例：

json
{
  "whereParams": [
    {
      "name": "",
      "symbol": "",
      "value": {},
      "values": []
    }
  ]
}

响应示例：

javascript
{
	"code": 0,
	"msg": "",
	"data": {}
}

selectList 列表查询接口 ​

管理后台-接口地址： /admin-api/lowcode/deploy-api/{apiName}/select-list

用户端-接口地址： /app-api/lowcode/deploy-api/{apiName}/select-list

请求方式： POST

接口描述： 根据查询配置，执行列表查询（不分页）

请求参数：

参数名称参数说明请求类型是否必须
apiName接口名称路径参数是
apiCode接口编码查询参数否
queryDomainParams请求参数请求体是
 pageParams分页参数否
  sortingFields排序参数否
   field排序字段否
   orderasc desc否
 whereParams查询参数否
  name查询字段名是
  symbol查询符号类型是
  value查询值（取决于 symbol 类型）取决于 symbol
  values查询值数组（取决于 symbol 类型）取决于 symbol

💡 使用提示

  • symbol 的值需匹配 QueryDomainSymbolType 枚举（如 EQ/LIKE/BETWEEN）
  • value 和 values 的实际值类型由 symbol 决定（例如 BETWEEN 需传入数组 [min, max]，IN 需传入列表）
    返回多条数据，不超过配置的最大返回行数

响应参数：

参数名称参数说明类型
code状态码Integer
msg返回信息String
data返回数据列表Array

请求示例：

json
{
  "pageParams": {
    "sortingFields": [
      {
        "field": "",
        "order": ""
      }
    ]
  },
  "whereParams": [
    {
      "name": "",
      "symbol": "",
      "value": {},
      "values": []
    }
  ]
}

响应示例：

javascript
{
	"code": 0,
	"msg": "",
	"data": []
}

selectCount 统计查询接口 ​

管理后台-接口地址： /admin-api/lowcode/deploy-api/{apiName}/select-count

用户端-接口地址： /app-api/lowcode/deploy-api/{apiName}/select-count

请求方式： POST

接口描述： 根据查询条件，统计符合条件的数据总数

请求参数：

参数名称参数说明请求类型是否必须
apiName接口名称路径参数是
apiCode接口编码查询参数否
queryDomainParams请求参数请求体是
 whereParams查询参数否
  name查询字段名是
  symbol查询符号类型是
  value查询值（取决于 symbol 类型）取决于 symbol
  values查询值数组（取决于 symbol 类型）取决于 symbol

💡 使用提示

  • symbol 的值需匹配 QueryDomainSymbolType 枚举（如 EQ/LIKE/BETWEEN）
  • value 和 values 的实际值类型由 symbol 决定（例如 BETWEEN 需传入数组 [min, max]，IN 需传入列表）

响应参数：

参数名称参数说明类型
code状态码Integer
msg返回信息String
data符合条件的记录总数Long

请求示例：

json
{
  "whereParams": [
    {
      "name": "",
      "symbol": "",
      "value": {},
      "values": []
    }
  ]
}

响应示例：

javascript
{
	"code": 0,
	"msg": "",
	"data": 0
}

export 数据导出接口 ​

管理后台-接口地址： /admin-api/lowcode/deploy-api/{apiName}/export

用户端-接口地址： 用户端不支持导出

请求方式： POST

接口描述： 根据查询条件，导出符合条件的数据（Excel文件流）

请求参数：

参数名称参数说明请求类型是否必须
apiName接口名称路径参数是
apiCode接口编码查询参数否
queryDomainParams请求参数请求体是
 pageParams分页参数）否
  sortingFields排序参数否
   field排序字段否
   orderasc desc否
 whereParams查询参数否
  name查询字段名是
  symbol查询符号类型是
  value查询值（取决于 symbol 类型）取决于 symbol
  values查询值数组（取决于 symbol 类型）取决于 symbol

💡 使用提示

  • symbol 的值需匹配 QueryDomainSymbolType 枚举（如 EQ/LIKE/BETWEEN）
  • value 和 values 的实际值类型由 symbol 决定（例如 BETWEEN 需传入数组 [min, max]，IN 需传入列表）
  • 实际导出行为由后端实现决定，最多导出 1000000 条数据

响应说明：

  • 成功时返回文件流（如 Excel、CSV），HTTP 状态码为 200
  • 响应头通常包含 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet 或类似 MIME 类型
  • 无结构化 JSON 响应体

请求示例：

json
{
  "pageParams": {
    "sortingFields": [
      {
        "field": "",
        "order": ""
      }
    ]
  },
  "whereParams": [
    {
      "name": "",
      "symbol": "",
      "value": {},
      "values": []
    }
  ]
}

响应示例：
（无 JSON 响应体，直接返回文件流）

前端使用示例

javascript
async () => {
    await message.exportConfirm()
    const resp = await request({
        url: '/lowcode/deploy-api/{apiName}/export',
        method: 'POST',
        responseType: 'blob',
        data: {}
    })
    download.excel(data, `测试导出.xls`)
}