---
url: /docs/api/intro.md
---

# 🕶️ 介绍

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

* `标题`
* `头信息`
* `请求信息`
* `响应信息`

## 默认头信息

|参数|必选|类型|说明
|  ---- | ---- |----|-----
|Authorization|是|String|认证 Token
|Request-From|是|String|默认值: Dashboard, 标记请求属于后台
:::info
在不做特殊说明下，每个请求将会默认带有两个默认值头信息
:::

## 公共响应格式

在 `CatchAdmin` 中，一般都是响应 `200 http code`，如果程序有异常，也不会返回 `500` 之类的 `http code`，它将会错误信息包裹到自定义响应数据中，下面是 `CatchAdmin` 的响应格式，请务必看下。
:::info
如果接口文档对响应内容没有做出特殊说明，只有`默认响应`，那么说明接口响应的数据是空数据。
:::

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

### 成功响应(分页格式)

|  字段   | 类型  |说明
|  ---- | ---- |----
| code  | int |返回码
| data  |  Array|返回数据
| limit  |  int|每页显示数量
| message  | string |返回信息
| total  | int |总数

### 成功响应(非分页)

|  字段   | 类型  |说明
|  ---- | ---- |----
| code  | int |返回码
| data  |  Object|Array |返回数据
| message  | string |返回信息

### 错误响应

|  字段   | 类型  |说明
|  ---- | ---- |----
| code  | int |返回码
| message  | string |返回信息

### 公共错误码

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