Skip to content
开源版扫码加好友进群讨论🎉

🕶️ 介绍

这是关于 CatchAdmin v3 版本的接口开发文档。这里会有关于 CatchAdmin 后台管理系统的所有的接口信息。除了开发模块的代码生成。针对每个接口会以这样格式进行输出。

  • 标题
  • 头信息
  • 请求信息
  • 响应信息

默认头信息

参数必选类型说明
AuthorizationString认证 Token
Request-FromString默认值: Dashboard, 标记请求属于后台

INFO

在不做特殊说明下,每个请求将会默认带有两个默认值头信息

公共响应格式

CatchAdmin 中,一般都是响应 200 http code,如果程序有异常,也不会返回 500 之类的 http code,它将会错误信息包裹到自定义响应数据中,下面是 CatchAdmin 的响应格式,请务必看下。

INFO

如果接口文档对响应内容没有做出特殊说明,只有默认响应,那么说明接口响应的数据是空数据。

INFO

没有做出特殊说明的情况下, 接口文档中响应参数中的字段说明都是 data 中的字段说明

成功响应(分页格式)

字段类型说明
codeint返回码
dataArray返回数据
limitint每页显示数量
messagestring返回信息
totalint总数

成功响应(非分页)

字段类型说明
codeint返回码
dataObject|Array返回数据
messagestring返回信息

错误响应

字段类型说明
codeint返回码
messagestring返回信息

公共错误码

code类型说明
10000int成功返回
10001int登录失效
10002int验证错误
10003int权限禁止
10004int登录失败
10005int操作失败
10006int登录失效
10007int黑名单
10008int账户被禁