# 广告模块

控制层 TypechoAdsController @author ads @date 2022/09/06

**类路径**：`AdsController`
**前缀**：`/typechoAds`

## 1. adsInfo

**接口路径**：`GET/POST /typechoAds/adsInfo`

**权限**：公开接口；但当系统配置 isLogin=1 时会强制要求登录

**接口说明**：参数请求报文: { "key":1 }

**请求参数**：

| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|--------|------|------|--------|------|
| id | String | 否 | - |  |
| token | String | 否 | - |  |

**响应说明**：
```json
{
  "code": 1,
  "msg": "",
  "data": ...
}
```

**前端调用参考**：
- 前端调用：this.$API.adsInfo()  （https://api.ruletree.club/typechoAds/adsInfo）

---

## 2. adsList

**接口路径**：`GET/POST /typechoAds/adsList`

**权限**：公开接口；但当系统配置 isLogin=1 时会强制要求登录

**接口说明**：广告列表 @param searchParams Bean对象JSON字符串 @param page         页码 @param limit        每页显示数量

**请求参数**：

| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|--------|------|------|--------|------|
| searchParams | String（JSON 字符串，需后端解析） | 否 | - | JSON 字符串，需后端解析 |
| searchKey | String | 否 | - |  |
| page | Integer | 否 | 1 |  |
| limit | Integer | 否 | 100 |  |
| token | String | 否 | - |  |

**响应说明**：
```json
{
  "code": 1,
  "msg": "",
  "data": ...
}
```

**前端调用参考**：
- 前端调用：this.$API.adsList()  （https://api.ruletree.club/typechoAds/adsList）

---

## 3. addAds

**接口路径**：`GET/POST /typechoAds/addAds`

**权限**：需要登录（普通用户及以上）

**接口说明**：表单插入 @param params Bean对象JSON字符串

**请求参数**：

| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|--------|------|------|--------|------|
| params | String（JSON 字符串，需后端解析） | 否 | - | JSON 字符串，需后端解析 |
| day | Integer | 否 | 0 |  |
| token | String | 否 | - |  |

**响应说明**：
```json
{
  "code": 1,
  "msg": "",
  "data": ...
}
```

**前端调用参考**：
- 前端调用：this.$API.addAds()  （https://api.ruletree.club/typechoAds/addAds）

---

## 4. editAds

**接口路径**：`GET/POST /typechoAds/editAds`

**权限**：需要登录（普通用户及以上）

**接口说明**：修改广告 @param params Bean对象JSON字符串

**请求参数**：

| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|--------|------|------|--------|------|
| params | String（JSON 字符串，需后端解析） | 否 | - | JSON 字符串，需后端解析 |
| token | String | 否 | - |  |

**响应说明**：
```json
{
  "code": 1,
  "msg": "",
  "data": ...
}
```

**前端调用参考**：
- 前端调用：this.$API.editAds()  （https://api.ruletree.club/typechoAds/editAds）

---

## 5. deleteAds

**接口路径**：`GET/POST /typechoAds/deleteAds`

**权限**：需要登录（普通用户及以上）

**接口说明**：广告删除

**请求参数**：

| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|--------|------|------|--------|------|
| id | String | 否 | - |  |
| token | String | 否 | - |  |

**响应说明**：
```json
{
  "code": 1,
  "msg": "",
  "data": ...
}
```

**前端调用参考**：
- 前端调用：this.$API.deleteAds()  （https://api.ruletree.club/typechoAds/deleteAds）

---

## 6. auditAds

**接口路径**：`GET/POST /typechoAds/auditAds`

**权限**：需要超级管理员权限

**接口说明**：广告审核

**请求参数**：

| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|--------|------|------|--------|------|
| id | String | 否 | - |  |
| token | String | 否 | - |  |

**响应说明**：
```json
{
  "code": 1,
  "msg": "",
  "data": ...
}
```

**前端调用参考**：
- 前端调用：this.$API.auditAds()  （https://api.ruletree.club/typechoAds/auditAds）

---

## 7. renewalAds

**接口路径**：`GET/POST /typechoAds/renewalAds`

**权限**：需要登录（普通用户及以上）

**接口说明**：广告续期

**请求参数**：

| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|--------|------|------|--------|------|
| id | String | 否 | - |  |
| token | String | 否 | - |  |
| day | Integer | 否 | 0 |  |

**响应说明**：
```json
{
  "code": 1,
  "msg": "",
  "data": ...
}
```

**前端调用参考**：
- 前端调用：this.$API.renewalAds()  （https://api.ruletree.club/typechoAds/renewalAds）

---

## 8. adsConfig

**接口路径**：`GET/POST /typechoAds/adsConfig`

**权限**：公开接口；但当系统配置 isLogin=1 时会强制要求登录

**接口说明**：广告配置信息

**请求参数**：

无请求参数

**响应说明**：
```json
{
  "code": 1,
  "msg": "",
  "data": ...
}
```

**前端调用参考**：
- 前端调用：this.$API.adsConfig()  （https://api.ruletree.club/typechoAds/adsConfig）

---