HTTP/HTTPS
请求协议
果创接口平台演示网站 / OpenAPI / 获取表格列表数据
获取表格列表数据
接口地址:http://yesx2.com/api/app.php?s=App.TESTDB.TableList
接口描述: 通用数据接口,获取表格列表数据,默认按ID降序返回,支持分页和搜索
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
page | 整型 | 可选 | 1 | 最小:1 | 第几页,从1开始 |
limit | 整型 | 可选 | 20 | 最小:1;最大:1000 | 分页数量,每页的数量 |
searchParams | 字符串JSON格式 | 可选 | [] | 搜索条件,JSON格式,键值对,默认使用相等判断,若指定条件则可使用问号表示,例如:{"username":"PhalApi","version > ?":"2.17.0"},复杂的条件或限制,请重载实现。 |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
page | 可选 | |
limit | 可选 | |
searchParams | 可选 |
客户端请求示例
# 暂无示例,可添加示例文件:./src/view/docs/demos/App.TESTDB.TableList.json
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | 表示客户端参数错误 |
404 | 表示接口服务不存在 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-09-08 09:18:57