example.md · 赵国庆/swagger-markdown-ui

# 星愿墙
接口文档

***版本: 1.2.0***

**联系方式:**  
开发者邮箱  
admin@conststar.cn

## 通用响应内容
 | 状态码 | 描述 |
| ---- | ----------- |
| 1000 | 服务器错误 |
| 10001 | 参数无效 |
| 10002 | 参数无效 |
| 10003 | 参数类型错误 |
| 10004 | 参数缺失 |
| 20001 | 用户未登录 |
| 20002 | 账号不存在或密码错误 |
| 20003 | 账号已被禁用 |
| 20004 | 用户不存在 |
| 20005 | 用户已存在 |
| 30001 | 某业务出现问题 |
| 40001 | 系统繁忙，请稍后重试 |
| 50001 | 数据未找到 |
| 50002 | 数据有误 |
| 50003 | 数据已存在 |
| 50004 | 查询出错 |
| 60001 | 内部系统接口调用异常 |
| 60002 | 外部系统接口调用异常 |
| 60003 | 该接口禁止访问 |
| 60004 | 接口地址无效 |
| 60005 | 接口请求超时 |
| 60006 | 接口负载过高 |
| 70001 | 无权限访问 |

## 接口列表
### 评论内容
 
#### 发布评论

POST: /api/comment/add

##### 描述:

发布评论，不返回内容

##### 参数

| 参数名 | 参数位于 | 描述 | 必须 | 参数类型 |
| ---- | ---------- | ----------- | -------- | ---- |
| tableId | query | 帖子id | Yes | integer |
| name | query | 姓名 | Yes | string |
| anonymous | query | 是否匿名 | Yes | boolean |
| content | query | 内容 | Yes | string |
| images | query | 图片列表 | Yes | string |
| token | header | token | No | string |

##### 响应
| 状态码 | 描述 | 请求头 | 返回类型 |
| ---- | ----------- | ------ |------ |
| 200 | OK | application/json;charset=UTF-8 | [ResponseGeneric«object»](#ResponseGeneric«object») |

#### 获取帖子评论总数

GET: /api/comment/count

##### 描述:

获取帖子评论总数，返回评论总数

##### 参数

| 参数名 | 参数位于 | 描述 | 必须 | 参数类型 |
| ---- | ---------- | ----------- | -------- | ---- |
| tableId | query | 帖子id | Yes | integer |
| token | header | token | No | string |

##### 响应
| 状态码 | 描述 | 请求头 | 返回类型 |
| ---- | ----------- | ------ |------ |
| 200 | OK | application/json;charset=UTF-8 | [ResponseGeneric«int»](#ResponseGeneric«int») |

#### 获取帖子分页评论列表

GET: /api/comment/pageList

##### 描述:

获取帖子分页评论列表，返回评论列表

##### 参数

| 参数名 | 参数位于 | 描述 | 必须 | 参数类型 |
| ---- | ---------- | ----------- | -------- | ---- |
| tableId | query | 帖子id | Yes | integer |
| pageIndex | query | 页索引 | Yes | integer |
| pageSize | query | 页大小 | Yes | integer |
| token | header | token | No | string |

##### 响应
| 状态码 | 描述 | 请求头 | 返回类型 |
| ---- | ----------- | ------ |------ |
| 200 | OK | application/json;charset=UTF-8 | [ResponseGeneric«List«评论实体»»](#ResponseGeneric«List«评论实体»») |

### 文件操作
 
#### 上传图片

POST: /api/file/image

##### 描述:

上传图片，返回上传的图片名

##### 参数

| 参数名 | 参数位于 | 描述 | 必须 | 参数类型 |
| ---- | ---------- | ----------- | -------- | ---- |
| token | header | token | No | string |

##### 响应
| 状态码 | 描述 | 请求头 | 返回类型 |
| ---- | ----------- | ------ |------ |
| 200 | OK | application/json;charset=UTF-8 | [ResponseGeneric«string»](#ResponseGeneric«string») |

#### 获取图片

GET: /api/file/image/{image}

##### 描述:

获取图片，返回图片文件

##### 参数

| 参数名 | 参数位于 | 描述 | 必须 | 参数类型 |
| ---- | ---------- | ----------- | -------- | ---- |
| image | path | 图片文件名 | Yes | string |

##### 响应
| 状态码 | 描述 | 请求头 | 返回类型 |
| ---- | ----------- | ------ |------ |
| 200 | OK | */* | string |

### 帖子内容
 
#### 发布表白

POST: /api/table/add

##### 描述:

发布表白，不返回内容

##### 参数

| 参数名 | 参数位于 | 描述 | 必须 | 参数类型 |
| ---- | ---------- | ----------- | -------- | ---- |
| sender | query | 表白者名称 | Yes | string |
| senderSex | query | 表白者性别 | Yes | integer |
| recipient | query | 被表白者名称 | Yes | string |
| recipientSex | query | 被表白者性别 | Yes | integer |
| anonymous | query | 是否匿名 | Yes | boolean |
| content | query | 表白内容 | Yes | string |
| images | query | 图片列表 | Yes | string |
| token | header | token | No | string |

#### 获取帖子总数

GET: /api/table/count

##### 描述:

获取帖子总数，返回帖子总数

##### 参数

| 参数名 | 参数位于 | 描述 | 必须 | 参数类型 |
| ---- | ---------- | ----------- | -------- | ---- |
| token | header | token | No | string |

#### 获取帖子分页列表

GET: /api/table/pageList

##### 描述:

获取帖子分页列表，返回帖子列表

##### 参数

| 参数名 | 参数位于 | 描述 | 必须 | 参数类型 |
| ---- | ---------- | ----------- | -------- | ---- |
| pageIndex | query | 页索引 | Yes | integer |
| pageSize | query | 页大小 | Yes | integer |
| token | header | token | No | string |

##### 响应
| 状态码 | 描述 | 请求头 | 返回类型 |
| ---- | ----------- | ------ |------ |
| 200 | OK | application/json;charset=UTF-8 | [ResponseGeneric«List«帖子实体»»](#ResponseGeneric«List«帖子实体»») |

#### 获取搜索帖子总数

GET: /api/table/searchCount

##### 描述:

获取搜索帖子总数，返回帖子数量

##### 参数

| 参数名 | 参数位于 | 描述 | 必须 | 参数类型 |
| ---- | ---------- | ----------- | -------- | ---- |
| keyword | query | 关键词 | Yes | string |
| token | header | token | No | string |

#### 搜索帖子

GET: /api/table/searchList

##### 描述:

搜索帖子，返回帖子列表

##### 参数

| 参数名 | 参数位于 | 描述 | 必须 | 参数类型 |
| ---- | ---------- | ----------- | -------- | ---- |
| keyword | query | 关键词 | Yes | string |
| pageIndex | query | 页索引 | Yes | integer |
| pageSize | query | 页大小 | Yes | integer |
| token | header | token | No | string |

#### 点赞

PUT: /api/table/support

##### 描述:

点赞，不返回内容

##### 参数

#### 取消点赞

DELETE: /api/table/support

##### 描述:

取消点赞，不返回内容

##### 参数

#### 获取单个帖子内容

GET: /api/table/table

##### 描述:

获取单个帖子内容，返回单个帖子

##### 参数

| 参数名 | 参数位于 | 描述 | 必须 | 参数类型 |
| ---- | ---------- | ----------- | -------- | ---- |
| id | query | 帖子id | Yes | integer |
| token | header | token | No | string |

##### 响应
| 状态码 | 描述 | 请求头 | 返回类型 |
| ---- | ----------- | ------ |------ |
| 200 | OK | application/json;charset=UTF-8 | [ResponseGeneric«帖子实体»](#ResponseGeneric«帖子实体») |

### 账号操作
 
#### 注册

POST: /api/user/add

##### 描述:

注册账号，不返回内容

##### 参数

| 参数名 | 参数位于 | 描述 | 必须 | 参数类型 |
| ---- | ---------- | ----------- | -------- | ---- |
| email | query | 邮箱 | Yes | string |
| password | query | 密码 | Yes | string |
| name | query | 姓名 | Yes | string |
| imageCode | query | 图片验证码 | Yes | string |
| emailCode | query | 邮箱验证 | Yes | string |

#### 登录

POST: /api/user/login

##### 描述:

登录用户，返回token

##### 参数

| 参数名 | 参数位于 | 描述 | 必须 | 参数类型 |
| ---- | ---------- | ----------- | -------- | ---- |
| email | query | 邮箱 | Yes | string |
| password | query | 密码 | Yes | string |

#### 退出登录

POST: /api/user/logout

##### 描述:

退出登录，不返回内容

##### 参数

| 参数名 | 参数位于 | 描述 | 必须 | 参数类型 |
| ---- | ---------- | ----------- | -------- | ---- |
| token | header | token | No | string |

#### 获取登录用户信息

GET: /api/user/user

##### 描述:

获取登录用户信息，返回用户公开信息

##### 参数

| 参数名 | 参数位于 | 描述 | 必须 | 参数类型 |
| ---- | ---------- | ----------- | -------- | ---- |
| token | header | token | No | string |

##### 响应
| 状态码 | 描述 | 请求头 | 返回类型 |
| ---- | ----------- | ------ |------ |
| 200 | OK | application/json;charset=UTF-8 | [ResponseGeneric«用户实体»](#ResponseGeneric«用户实体») |

#### 获取用户公开信息

GET: /api/user/userPublic

##### 描述:

获取用户公开信息，返回用户公开信息

##### 参数

| 参数名 | 参数位于 | 描述 | 必须 | 参数类型 |
| ---- | ---------- | ----------- | -------- | ---- |
| id | query | 用户id | Yes | integer |
| token | header | token | No | string |

##### 响应
| 状态码 | 描述 | 请求头 | 返回类型 |
| ---- | ----------- | ------ |------ |
| 200 | OK | application/json;charset=UTF-8 | [ResponseGeneric«用户公开信息»](#ResponseGeneric«用户公开信息») |

#### 获取邮箱验证码

GET: /api/user/verifyEmail

##### 描述:

获取邮箱验证码，不返回内容

##### 参数

| 参数名 | 参数位于 | 描述 | 必须 | 参数类型 |
| ---- | ---------- | ----------- | -------- | ---- |
| email | query | 邮箱 | Yes | string |
| imageCode | query | 图形验证码 | Yes | string |

##### 响应
| 状态码 | 描述 | 请求头 | 返回类型 |
| ---- | ----------- | ------ |------ |
| 200 | OK | application/json;charset=UTF-8 | [ResponseGeneric«object»](#ResponseGeneric«object») |
| 200 | OK | application/json;charset=UTF-100 | [ResponseGeneric«object»](#ResponseGeneric«object») |

#### 获取图片验证码

GET: /api/user/verifyImage

##### 描述:

获取图片验证码，返回图片base64

##### 参数

| 参数名 | 参数位于 | 描述 | 必须 | 参数类型 |
| ---- | ---------- | ----------- | -------- | ---- |
| email | query | 邮箱 | Yes | string |

## 返回类型

#### ResponseGeneric«List«帖子实体»»

| 参数名 | 类型 | 描述 | 必须 |
| ---- | ---- | ----------- | -------- |
| code | string | 状态码 | No |
| data | [ [帖子实体](#帖子实体) ] | 数据 | No |
| message | string | 消息 | No |

#### ResponseGeneric«List«评论实体»»

| 参数名 | 类型 | 描述 | 必须 |
| ---- | ---- | ----------- | -------- |
| code | string | 状态码 | No |
| data | [ [评论实体](#评论实体) ] | 数据 | No |
| message | string | 消息 | No |

#### ResponseGeneric«int»

| 参数名 | 类型 | 描述 | 必须 |
| ---- | ---- | ----------- | -------- |
| code | string | 状态码 | No |
| data | integer | 数据 | No |
| message | string | 消息 | No |

#### ResponseGeneric«object»

| 参数名 | 类型 | 描述 | 必须 |
| ---- | ---- | ----------- | -------- |
| code | string | 状态码 | No |
| data | object | 数据 | No |
| message | string | 消息 | No |

#### ResponseGeneric«string»

| 参数名 | 类型 | 描述 | 必须 |
| ---- | ---- | ----------- | -------- |
| code | string | 状态码 | No |
| data | string | 数据 | No |
| message | string | 消息 | No |

#### ResponseGeneric«帖子实体»

| 参数名 | 类型 | 描述 | 必须 |
| ---- | ---- | ----------- | -------- |
| code | string | 状态码 | No |
| data | [帖子实体](#帖子实体) | 数据 | No |
| message | string | 消息 | No |

#### ResponseGeneric«用户公开信息»

| 参数名 | 类型 | 描述 | 必须 |
| ---- | ---- | ----------- | -------- |
| code | string | 状态码 | No |
| data | [用户公开信息](#用户公开信息) | 数据 | No |
| message | string | 消息 | No |

#### ResponseGeneric«用户实体»

| 参数名 | 类型 | 描述 | 必须 |
| ---- | ---- | ----------- | -------- |
| code | string | 状态码 | No |
| data | [用户实体](#用户实体) | 数据 | No |
| message | string | 消息 | No |

#### 帖子实体

| 参数名 | 类型 | 描述 | 必须 |
| ---- | ---- | ----------- | -------- |
| anonymous | boolean | 是否为匿名 | No |
| commentCount | integer | 评论数量 | No |
| content | string | 表白内容 | No |
| createTime | dateTime | 创建时间 | No |
| id | integer | 帖子id | No |
| images | string | 图片列表 | No |
| recipient | string | 被表白者姓名 | No |
| recipientSex | integer | 被表白者性别 | No |
| sender | string | 表白者姓名 | No |
| senderSex | integer | 表白者性别 | No |
| status | integer | 状态 0为正常 1为待审核 -1为封禁 | No |
| support | boolean | 是否点过赞 | No |
| supportCount | integer | 点赞数量 | No |
| userPublic | [用户公开信息](#用户公开信息) | 对应的用户公开信息 | No |

#### 用户公开信息

| 参数名 | 类型 | 描述 | 必须 |
| ---- | ---- | ----------- | -------- |
| createTime | dateTime | 注册时间 | No |
| email | string | 邮箱 | No |
| id | integer | 账号id | No |
| lastTime | dateTime | 最近登录时间 | No |
| name | string | 名称 | No |
| studentId | string | 学号 | No |

#### 用户实体

#### 评论实体

| 参数名 | 类型 | 描述 | 必须 |
| ---- | ---- | ----------- | -------- |
| anonymous | boolean | 是否为匿名 | No |
| content | string | 评论内容 | No |
| createTime | dateTime | 评论创建时间 | No |
| id | integer | 评论id | No |
| images | string | 图片列表 | No |
| name | string | 匿名名称 | No |
| status | integer | 状态 0为正常 1为待审核 -1为封禁 | No |
| tableId | integer | 帖子id | No |
| userPublic | [用户公开信息](#用户公开信息) | 对应的用户公开信息 | No |
| user_id | integer | 评论者id | No |

赵国庆/swagger-markdown-ui

简介

发行版

贡献者

语言

近期动态

赵国庆/swagger-markdown-ui .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

语言

近期动态

搜索帮助

赵国庆/swagger-markdown-ui