175 lines
3.1 KiB
Markdown
175 lines
3.1 KiB
Markdown
# API文档
|
||
|
||
## 基础信息
|
||
- 响应格式: 所有接口都会返回统一的`Result`格式
|
||
```json
|
||
{
|
||
"code": 200, // 状态码
|
||
"msg": "", // 错误信息
|
||
"data": {} // 具体响应数据
|
||
}
|
||
```
|
||
|
||
## 广告模块
|
||
|
||
### 1. 创建广告
|
||
- 请求方式: `POST`
|
||
- 请求路径: `/ad`
|
||
- 请求体:
|
||
```json
|
||
{
|
||
"title": "广告标题",
|
||
"img": "图片URL",
|
||
"sort": 1 // 排序序号
|
||
}
|
||
```
|
||
- 响应:
|
||
```json
|
||
{
|
||
"code": 200,
|
||
"msg": "",
|
||
"data": null
|
||
}
|
||
```
|
||
|
||
### 2. 修改广告
|
||
- 请求方式: `PUT`
|
||
- 请求路径: `/ad`
|
||
- 请求体:
|
||
```json
|
||
{
|
||
"id": "广告ID",
|
||
"title": "广告标题",
|
||
"img": "图片URL",
|
||
"sort": 1
|
||
}
|
||
```
|
||
- 响应:
|
||
```json
|
||
{
|
||
"code": 200,
|
||
"msg": "",
|
||
"data": null
|
||
}
|
||
```
|
||
|
||
### 3. 删除广告
|
||
- 请求方式: `DELETE`
|
||
- 请求路径: `/ad/{id}`
|
||
- 路径参数: `id` - 广告ID
|
||
- 响应:
|
||
```json
|
||
{
|
||
"code": 200,
|
||
"msg": "",
|
||
"data": null
|
||
}
|
||
```
|
||
|
||
### 4. 获取单个广告
|
||
- 请求方式: `GET`
|
||
- 请求路径: `/ad/{id}`
|
||
- 路径参数: `id` - 广告ID
|
||
- 响应:
|
||
```json
|
||
{
|
||
"code": 200,
|
||
"msg": "",
|
||
"data": {
|
||
"id": "广告ID",
|
||
"title": "广告标题",
|
||
"img": "图片URL",
|
||
"sort": 1
|
||
}
|
||
}
|
||
```
|
||
|
||
### 5. 获取广告列表
|
||
- 请求方式: `GET`
|
||
- 请求路径: `/ad`
|
||
- 响应:
|
||
```json
|
||
{
|
||
"code": 200,
|
||
"msg": "",
|
||
"data": [
|
||
{
|
||
"id": "广告ID",
|
||
"title": "广告标题",
|
||
"img": "图片URL",
|
||
"sort": 1
|
||
}
|
||
]
|
||
}
|
||
```
|
||
|
||
## 队伍模块
|
||
基础路径: `/api/teams`
|
||
|
||
### 1. 创建队伍
|
||
- 请求方式: `POST`
|
||
- 请求路径: `/api/teams`
|
||
- 请求体: `Team`对象
|
||
- 响应: 成功返回空数据
|
||
|
||
### 2. 删除队伍
|
||
- 请求方式: `DELETE`
|
||
- 请求路径: `/api/teams/{id}`
|
||
- 路径参数: `id` - 队伍ID
|
||
- 响应: 成功返回空数据
|
||
|
||
### 3. 更新队伍
|
||
- 请求方式: `PUT`
|
||
- 请求路径: `/api/teams`
|
||
- 请求体: `Team`对象
|
||
- 响应: 成功返回空数据
|
||
|
||
### 4. 获取单个队伍
|
||
- 请求方式: `GET`
|
||
- 请求路径: `/api/teams/{id}`
|
||
- 路径参数: `id` - 队伍ID
|
||
- 响应: 返回队伍详细信息
|
||
|
||
### 5. 分页获取队伍列表
|
||
- 请求方式: `GET`
|
||
- 请求路径: `/api/teams/page`
|
||
- 请求参数:
|
||
- `pageNum`: 页码（默认1）
|
||
- `pageSize`: 每页大小（默认10）
|
||
- 响应: 返回分页数据
|
||
|
||
## 比赛模块
|
||
基础路径: `/api/matches`
|
||
|
||
### 1. 创建比赛
|
||
- 请求方式: `POST`
|
||
- 请求路径: `/api/matches`
|
||
- 请求体: `Match`对象
|
||
- 响应: 成功返回空数据
|
||
|
||
### 2. 删除比赛
|
||
- 请求方式: `DELETE`
|
||
- 请求路径: `/api/matches/{id}`
|
||
- 路径参数: `id` - 比赛ID
|
||
- 响应: 成功返回空数据
|
||
|
||
### 3. 更新比赛
|
||
- 请求方式: `PUT`
|
||
- 请求路径: `/api/matches`
|
||
- 请求体: `Match`对象
|
||
- 响应: 成功返回空数据
|
||
|
||
### 4. 获取单个比赛
|
||
- 请求方式: `GET`
|
||
- 请求路径: `/api/matches/{id}`
|
||
- 路径参数: `id` - 比赛ID
|
||
- 响应: 返回包含队伍信息的比赛详细信息
|
||
|
||
### 5. 分页获取比赛列表
|
||
- 请求方式: `GET`
|
||
- 请求路径: `/api/matches/page`
|
||
- 请求参数:
|
||
- `pageNum`: 页码（默认1）
|
||
- `pageSize`: 每页大小（默认10）
|
||
- `teamId`: 队伍ID（可选）
|
||
- 响应: 返回包含队伍信息的分页数据 |