小白接口

查询搜索数据

接口链接: http://api.okayapi.com/?s=App.Table.Query

功能说明: 「即将弃用,请改用App.Table.FreeQuery」根据查询字段、查询条件、排序规则、分页查询数据。是最为灵活的查询,但只能单表查询,并符合安全规范。为保障数据安全,部分关键字会被转义,如select会被自动改为se1ect。

请求协议:HTTP、HTTPS

请求方式:GET、POST

编码格式:UTF-8

操作: 在线调试    添加收藏

免费热门

接口参数

参数名字类型是否必须默认值其他说明
sign字符串可选签名,如果不需要签名,可在小白后台进行签名设置
app_key字符串必须最小:32;最大:32应用ID
uuid字符串可选最小:32;最大:32需要绑定的UUID,全局唯一用户ID。如果有传递此参数,则数据将会与特定用户绑定;如果不传,则为全局数据。
token字符串可选最小:64;最大:64会话凭证
model_name字符串必须模型名称(对应在小白后台创建时的数据库表名称)
check_code字符串可选最大:64待检测的口令,仅当在小白后台配置口令后才会对此参数进行检测
select字符串可选*SQL语句的SELECT部分,如:select=id,uuid
where字符串可选SQL语句的WHERE部分,如:where=id > 1
order字符串可选id DESCSQL语句的ORDER部分,如:order = id DESC
page整型可选1最小:1第几页
perpage整型可选10最小:1;最大:2500分页数量
return_sql布尔型可选false是否需要返回当前查询的sql片段,默认不返回,调试时可开启

返回结果

返回字段类型说明
err_code整型状态操作码,0成功;1开发类错误,查询失败(模型不存在或查询错误);2应用层规则拦截,拦截后可以小白后台查看日记
err_msg字符串错误提示信息,err_code非0时参考此提示信息
total整型数据的总条目数量
list数组查询的结果列表数据
sql对象经过解析后的SQL语句片段,便于开发人进行校对(return_sql为true时才返回)
sql.select字符串解析后的查询字段
sql.where字符串解析后的查询条件
sql.order字符串解析后的排序规则

异常情况

错误码错误描述信息
400非法请求,参数错误
401用户未登录,或登录凭证已过期
404接口服务不存在
406权限不足,应用签名错误、或者应用已过期
500小白接口内部系统错误,如果出现此错误,请联系技术人员处理