接口大师[旗舰版演示]
/
后台接口
/
获取API接口列表
接口地址：http://www.yesx2.com/api/admin.php?s=Admin.ApiDesign.GetApiList
接口描述： 获取API接口列表，支持条件搜索
接口大师[旗舰版演示] / 后台接口 / 获取API接口列表
接口地址：http://www.yesx2.com/api/admin.php?s=Admin.ApiDesign.GetApiList
接口描述： 获取API接口列表，支持条件搜索
| 参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
|---|
| access_token | 字符串 | 可选 | | | 访问令牌，仅当开启签名验证时需要传递，生成令牌可使用App.Auth.ApplyToken接口 |
| id | 整型 | 可选 | - | | 接口id |
| api_name | 字符串 | 可选 | - | | 接口服务，模糊匹配 |
| api_title | 字符串 | 可选 | - | | 接口服务名称，模糊匹配 |
| is_finish | 字符串 | 可选 | | | 状态，1已发布0草稿，空字符串表示全部 |
| page | 整型 | 可选 | 1 | | 当前页数 |
| perpage | 整型 | 可选 | 10 | | 每页多少条 |
| api_group | 字符串 | 可选 | - | | 接口分组 |
| 返回结果 | 类型 | 说明 |
|---|
| ret | 整型 | 状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务器错误 |
| data | 对象或混合类型 | 业务数据，由各自接口指定，通常为对象 |
| data.total | 整型 | 总数 |
| data.items | 数组 | 列表数据 |
| data.items[].is_finish_name | 字符串 | 状态名称 |
| data.items[].api_doc_link | 字符串 | 接口文档链接 |
| data.items[].add_time | 字符串 | 添加时间 |
| data.items[].add_username | 字符串 | 添加人 |
| data.items[].update_time | 字符串 | 更新时间 |
| data.items[].update_username | 字符串 | 更新人 |
| data.items[].publish_time | 字符串 | 发布时间 |
| data.items[].publish_username | 字符串 | 发布人 |
| msg | 字符串 | 提示信息，失败时的错误提示 |
# 暂无示例，可添加示例文件：./src/view/docs/demos/Admin.ApiDesign.GetApiList.json
| 错误状态码 | 错误描述信息 |
|---|
| 400 | ret=400，客户端参数错误或非法请求 |
| 404 | 表示接口服务不存在 |
| 406 | ret=406，access_token令牌校验不通过 |
| 407 | ret=407，app_key权限不足，或未知应用 |
| 408 | ret=408，当前用户禁止使用，或用户未登录 |
| 409 | ret=409，接口流量不足 |
| 410 | ret=410，接口限流 |
| 500 | 表示服务端内部错误 |
本文档生成时间：2024-05-03 17:52:39
