服务引擎

获取授权接口

• [url] /api/clients/auth
• [METHOD] POST
• [Content-Type] multipart/form-data

入参

参数名称	参数类型	参数说明
ciphertext	boolean	是否加密
client	string	账号
secret	string	密钥

出参

参数名称	参数类型	参数文档
client	string	账号
token	string	token
expiresAt	long	失效时间

调用示例

查询接口

• [url] /api/sql-services/:id/query
• [METHOD] GET/POST
• [Content-Type] application/json

调用前置条件

需将获取授权接口中获取到的 token 参数传入

在 header 中添加 Authorization: Bearer {token}
或者在 postman 中将 token 填写到下图中的对应位置

入参

参数名称	参数类型	参数说明
criteria	json	查询条件
pageSize	int	每页显示条目个数
pageNumber	int	当前页数
sorts	int	排序条件

出参

参数名称	参数类型	参数文档
content	array	查询结果
totalPages	string	总页数
pageNumber	int	当前页数
pageSize	int	每页显示条目个数
totalElements	int	总条数
orderBy	int	排序条件
contentSize	int	查询结果条数

{
  "criteria": {
    "children": [
      {
        "match": "eq",
        "name": "name",
        "value": ["张无忌"]
      }
    ],
    "match": "AND"
  }
}

调用示例

match 说明

value	等效 sql 匹配符号	传递 value 数组大小
eq	=	1
ne	<>	1
gt	>	1
ge	>=	1
lt	<	1
le	<=	1
like	LIKE	1
not_like	NOT LIKE	1
between	BETWEEN	2
not_between	NOT BETWEEN	2
in	IN	不限
not_in	not_in	不限
not_null	IS NOT NULL	0
is_null	IS NULL	0

导出文件

• [url] /api/sql-services/:id/export
• [METHOD] POST
• [Content-Type] application/json
• [PARAM] 参数

参数名称	参数类型	参数文档	参数默认
mediaType	string	导出类型

示例: