API 设计

Base URLs:

开发环境：http://localhost:8080

生产环境：https://nottinghamwall.yiming1234.cn

用户端公共接口

POST 学生上传文件

POST /student/common/upload

上传文件

yaml

files: string

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none
body	body	object	否	none
» files	body	string(binary)	是	none

json

{
  "code": 0,
  "msg": "",
  "data": ""
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultListString

POST 学生删除文件

POST /student/common/delete

删除文件

json

{
  "key": "string"
}

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none
body	body	MapString	否	none

json

{
  "code": 0,
  "msg": "",
  "data": [
    ""
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultListString

用户端学生接口

POST 微信登录

POST /student/login/login

微信登录

json

{
  "code": "string"
}

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none
body	body	StudentLoginDTO	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "openid": "",
    "token": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultStudentLoginVO

POST 微信获取手机号

POST /student/login/getPhoneNumber

微信获取手机号

请求参数

名称	位置	类型	必选	说明
code	query	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": ""
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultString

GET 获取当前用户信息

GET /student/get/currentUserInfo

获取当前用户信息

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {
    "": {}
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultMapObject

GET 获取学生信息

GET /student/get/info

获取学生信息

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "openid": "",
    "studentid": "",
    "username": "",
    "email": "",
    "phone": "",
    "sex": "",
    "idNumber": "",
    "avatar": "",
    "createTime": "",
    "updateTime": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultStudent

GET 根据id获取学生信息

GET /student/get/info/

根据id获取学生信息

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "openid": "",
    "studentid": "",
    "username": "",
    "email": "",
    "phone": "",
    "sex": "",
    "idNumber": "",
    "avatar": "",
    "createTime": "",
    "updateTime": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultStudent

GET 根据用户名获取学生信息

GET /student/get/info/username/

根据用户名获取学生信息

请求参数

名称	位置	类型	必选	说明
username	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "openid": "",
    "studentid": 0,
    "username": "",
    "email": "",
    "phone": "",
    "sex": "",
    "idNumber": "",
    "avatar": "",
    "createTime": "",
    "updateTime": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultStudent

PUT 更新学生信息

PUT /student/update/info

更新学生信息

json

{
  "id": 0,
  "studentid": 0,
  "username": "string",
  "name": "string",
  "avatar": "string",
  "email": "string",
  "phone": "string",
  "sex": "string",
  "idNumber": "string"
}

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none
body	body	StudentDTO	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {}
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultVoid

GET 获取发布的帖子（分页）

GET /student/get/publish

获取发布的帖子（分页）

请求参数

名称	位置	类型	必选	说明
page	query	integer	是	none
pageSize	query	integer	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {
    "total": 0,
    "records": [
      {
        "id": 0,
        "content": "",
        "authorID": 0,
        "imgURLs": [
          ""
        ],
        "createdAt": "",
        "updatedAt": ""
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultPageResultTopic

GET 获取评论的帖子（分页）

GET /student/get/comment

获取评论的帖子（分页）

请求参数

名称	位置	类型	必选	说明
page	query	integer	是	none
pageSize	query	integer	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {
    "total": 0,
    "records": [
      {
        "id": 0,
        "content": "",
        "authorID": 0,
        "imgURLs": [
          ""
        ],
        "createdAt": "",
        "updatedAt": ""
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultPageResultTopic

GET 获取收藏的帖子（分页）

GET /student/get/collect

获取收藏的帖子（分页）

请求参数

名称	位置	类型	必选	说明
page	query	integer	是	none
pageSize	query	integer	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {
    "total": 0,
    "records": [
      {
        "id": 0,
        "content": "",
        "authorID": 0,
        "imgURLs": [
          ""
        ],
        "createdAt": "",
        "updatedAt": ""
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultPageResultTopic

用户端话题接口

POST 创建话题

POST /student/post/topic

创建话题

json

{
  "id": 0,
  "content": "string",
  "imgURLs": [
    "string"
  ],
  "authorID": 0,
  "createdAt": "string",
  "updatedAt": "string",
  "isDraft": true
}

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none
body	body	TopicDTO	否	none

json

{
  "code": 0,
  "msg": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultVoid

DELETE 删除话题

DELETE /student/delete/topic/

删除话题

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultVoid

POST 新建草稿

POST /student/save/draft

新建草稿

json

{
  "id": 0,
  "content": "string",
  "imgURLs": [
    "string"
  ],
  "authorID": 0,
  "createdAt": "string",
  "updatedAt": "string",
  "isDraft": true
}

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none
body	body	TopicDTO	否	none

json

{
  "code": 0,
  "msg": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultVoid

GET 获取草稿

GET /student/get/draft

获取草稿

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "content": "",
    "authorID": 0,
    "imgURLs": [
      ""
    ],
    "createdAt": "",
    "updatedAt": "",
    "isDraft": false
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultTopic

DELETE 删除草稿

DELETE /student/delete/draft/

删除草稿

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultVoid

GET 检查是否存在草稿

GET /student/isexist/draft

检查是否存在草稿

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": false
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultBoolean

GET 实现话题无限滚动

GET /student/get/topic

实现话题无限滚动

请求参数

名称	位置	类型	必选	说明
name	query	string	否	none
tags	query	string	否	none
username	query	string	否	none
page	query	integer	否	none
pageSize	query	integer	否	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {
    "total": 0,
    "records": [
      {}
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultPageResultTopic

GET 根据id获取话题详情

GET /student/topic/

根据id获取话题详情

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "content": "",
    "authorID": 0,
    "imgURLs": [
      ""
    ],
    "createdAt": "",
    "updatedAt": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultTopic

POST 点赞话题

POST /student/like/topic/

点赞话题

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultVoid

POST 取消点赞话题

POST /student/unlike/topic/

取消点赞话题

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultVoid

GET 是否点赞话题

GET /student/islike/topic/

是否点赞话题

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": false
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultBoolean

GET 获取点赞计数

GET /student/like/count/

获取点赞计数

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultInteger

POST 收藏话题

POST /student/collect/topic/

收藏话题

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultVoid

POST 取消收藏话题

POST /student/uncollect/topic/

取消收藏话题

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultVoid

GET 是否收藏话题

GET /student/iscollect/topic/

是否收藏话题

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": false
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultBoolean

GET 获取收藏计数

GET /student/collect/count/

获取收藏计数

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultInteger

用户端评论接口

POST 评论话题

POST /student/comment/topic/

评论话题

json

{
  "id": 0,
  "topicId": 0,
  "userId": 0,
  "content": "string",
  "parentId": 0,
  "createdAt": "string",
  "updatedAt": "string",
  "user": {
    "id": 0,
    "studentid": 0,
    "username": "string",
    "name": "string",
    "avatar": "string",
    "email": "string",
    "phone": "string",
    "sex": "string",
    "idNumber": "string"
  },
  "replies": [
    {
      "id": 0,
      "topicId": 0,
      "userId": 0,
      "content": "string",
      "parentId": 0,
      "createdAt": "string",
      "updatedAt": "string",
      "user": {
        "id": 0,
        "studentid": 0,
        "username": "string",
        "name": "string",
        "avatar": "string",
        "email": "string",
        "phone": "string",
        "sex": "string",
        "idNumber": "string"
      },
      "replies": [
        {
          "id": 0,
          "topicId": 0,
          "userId": 0,
          "content": "string",
          "parentId": 0,
          "createdAt": "string",
          "updatedAt": "string",
          "user": {
            "id": null,
            "studentid": null,
            "username": null,
            "name": null,
            "avatar": null,
            "email": null,
            "phone": null,
            "sex": null,
            "idNumber": null
          },
          "replies": [
            {}
          ]
        }
      ]
    }
  ]
}

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none
body	body	CommentDTO	否	none

json

{
  "code": 0,
  "msg": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultVoid

DELETE 删除评论

DELETE /student/delete/comment/

删除评论

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultVoid

POST 点赞评论

POST /student/like/comment/

点赞评论

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultVoid

POST 取消点赞评论

POST /student/unlike/comment/

取消点赞评论

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": null
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultVoid

GET 检查是否点赞评论

GET /student/islike/comment/

检查是否点赞评论

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": false
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultBoolean

GET 获取评论点赞计数

GET /student/like/comment/count/

获取评论点赞计数

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultInteger

GET 获取评论

GET /student/get/comments/

获取指定话题的所有评论，并进行分页处理。

请求参数

名称	位置	类型	必选	说明
topicId	path	string	是	话题ID
page	query	integer	是	页码（从1开始）
pageSize	query	integer	是	每页大小
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {
    "total": 0,
    "list": [
      {
        "id": 0,
        "topicId": 0,
        "userId": 0,
        "content": "",
        "parentId": 0,
        "createdAt": "",
        "updatedAt": "",
        "user": {
          "id": 0,
          "studentid": 0,
          "username": "",
          "name": "",
          "avatar": "",
          "email": "",
          "phone": "",
          "sex": "",
          "idNumber": ""
        },
        "replies": [
          {
            "id": 0,
            "topicId": 0,
            "userId": 0,
            "content": "",
            "parentId": 0,
            "createdAt": "",
            "updatedAt": "",
            "user": {
              "id": 0,
              "studentid": 0,
              "username": "",
              "name": "",
              "avatar": "",
              "email": "",
              "phone": "",
              "sex": "",
              "idNumber": ""
            },
            "replies": []
          }
        ]
      }
    ],
    "pageNum": 0,
    "pageSize": 0,
    "size": 0,
    "startRow": 0,
    "endRow": 0,
    "pages": 0,
    "prePage": 0,
    "nextPage": 0,
    "isFirstPage": false,
    "isLastPage": false,
    "hasPreviousPage": false,
    "hasNextPage": false,
    "navigatePages": 0,
    "navigatepageNums": [
      0
    ],
    "navigateFirstPage": 0,
    "navigateLastPage": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultPageInfoCommentDTO

GET 获取评论计数

GET /student/comment/count/

获取评论计数

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultInteger

用户端举报接口

POST 举报

POST /student/report/insert

json

{
  "id": 0,
  "topicId": 0,
  "commentId": 0,
  "authorId": 0,
  "userId": 0,
  "tags": "string",
  "detailedDescription": "string"
}

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none
body	body	ReportDTO	否	none

json

null

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	string

管理端公共接口

POST 管理员上传文件

POST /admin/common/upload

上传文件

yaml

file: string

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none
body	body	object	否	none
» file	body	string(binary)	否	none

json

{
  "code": 0,
  "msg": "",
  "data": ""
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultString

POST 管理员删除文件

POST /admin/common/delete

删除文件

请求参数

名称	位置	类型	必选	说明
file	query	string	否	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": ""
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultString

管理端管理员接口

POST 登录

POST /admin/manage/login

json

{
  "username": "string",
  "password": "string"
}

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none
body	body	AdminLoginDTO	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "userName": "",
    "name": "",
    "token": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultAdminLoginVO

POST 退出

POST /admin/manage/logout

退出

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": ""
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultString

POST 新增管理员

POST /admin/manage

新增管理员

json

{
  "id": 0,
  "username": "string",
  "name": "string",
  "phone": "string",
  "sex": "string",
  "idNumber": "string"
}

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none
body	body	AdminDTO	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {}
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Result

PUT 修改管理员

PUT /admin/manage

修改管理员

json

{
  "id": 0,
  "username": "string",
  "name": "string",
  "phone": "string",
  "sex": "string",
  "idNumber": "string"
}

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none
body	body	AdminDTO	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {}
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Result

POST 启用或停用管理员

POST /admin/manage/status/

启用或停用管理员

请求参数

名称	位置	类型	必选	说明
status	path	string	是	none
id	query	integer	否	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {}
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Result

GET 分页查询管理员

GET /admin/manage/page

管理员分页查询

请求参数

名称	位置	类型	必选	说明
name	query	string	否	员工姓名
page	query	integer	否	页码
pageSize	query	integer	否	每页显示记录数
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {
    "total": 0,
    "records": [
      {}
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultPageResult

GET 根据id查询管理员

GET /admin/manage/

根据id查询管理员

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "username": "",
    "name": "",
    "password": "",
    "phone": "",
    "sex": "",
    "idNumber": "",
    "status": 0,
    "createTime": "",
    "updateTime": "",
    "createUser": 0,
    "updateUser": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultAdmin

管理端学生接口

GET 分页查询学生

GET /admin/student/page

学生分页查询

请求参数

名称	位置	类型	必选	说明
username	query	string	否	用户姓名
page	query	integer	否	页码
pageSize	query	integer	否	每页显示记录数
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {
    "total": 0,
    "records": [
      {}
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultPageResult

GET 根据id查询学生

GET /admin/student/

根据id查询学生

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "openid": "",
    "studentid": "",
    "username": "",
    "email": "",
    "phone": "",
    "sex": "",
    "idNumber": "",
    "avatar": "",
    "createTime": "",
    "updateTime": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultStudent

GET 根据学号查询学生

GET /admin/student/

根据学号查询学生

请求参数

名称	位置	类型	必选	说明
studentId	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "openid": "",
    "studentid": "",
    "username": "",
    "email": "",
    "phone": "",
    "sex": "",
    "idNumber": "",
    "avatar": "",
    "createTime": "",
    "updateTime": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultStudent

GET 根据邮箱查询学生

GET /admin/student/

根据邮箱查询学生

请求参数

名称	位置	类型	必选	说明
email	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "openid": "",
    "studentid": "",
    "username": "",
    "email": "",
    "phone": "",
    "sex": "",
    "idNumber": "",
    "avatar": "",
    "createTime": "",
    "updateTime": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultStudent

uniapp管理接口

GET 获取状态

GET /student/uniapp/status

学生端获取状态

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultInteger

PUT 设置状态

PUT /admin/uniapp/

设置状态

请求参数

名称	位置	类型	必选	说明
status	path	string	是	none
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": {}
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Result

GET 获取状态

GET /admin/uniapp/status

管理端获取状态

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none

json

{
  "code": 0,
  "msg": "",
  "data": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultInteger

数据模型

StudentLoginVO

json

{
  "id": 0,
  "openid": "string",
  "token": "string"
}

属性

名称	类型	必选	约束	说明
id	integer	false	none	none
openid	string	false	none	none
token	string	false	none	none

AdminLoginVO

json

{
  "id": 0,
  "userName": "string",
  "name": "string",
  "token": "string"
}

属性

名称	类型	必选	约束	说明
id	integer	false	none	主键值
userName	string	false	none	用户名
name	string	false	none	姓名
token	string	false	none	jwt令牌

ResultInteger

json

{
  "code": 0,
  "msg": "string",
  "data": 0
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	integer	false	none	数据

TopicDTO

json

{
  "id": 0,
  "content": "string",
  "imgURLs": [
    "string"
  ],
  "authorID": 0,
  "createdAt": "string",
  "updatedAt": "string",
  "isDraft": true
}

属性

名称	类型	必选	约束	说明
id	integer	false	none	none
content	string	false	none	none
imgURLs	[string]	false	none	none
authorID	integer	false	none	none
createdAt	string	false	none	none
updatedAt	string	false	none	none
isDraft	boolean	false	none	none

ResultVoid

json

{
  "code": 0,
  "msg": "string",
  "data": null
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	null	false	none	数据

ResultListString

json

{
  "code": 0,
  "msg": "string",
  "data": [
    "string"
  ]
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	[string]	false	none	数据

ReportDTO

json

{
  "id": 0,
  "topicId": 0,
  "commentId": 0,
  "authorId": 0,
  "userId": 0,
  "tags": "string",
  "detailedDescription": "string"
}

属性

名称	类型	必选	约束	说明
id	integer	false	none	none
topicId	integer	false	none	none
commentId	integer	false	none	none
authorId	integer	false	none	none
userId	integer	false	none	none
tags	string	false	none	none
detailedDescription	string	false	none	none

ResultStudentLoginVO

json

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": 0,
    "openid": "string",
    "token": "string"
  }
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	StudentLoginVO	false	none	数据

ResultAdminLoginVO

json

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": 0,
    "userName": "string",
    "name": "string",
    "token": "string"
  }
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	AdminLoginVO	false	none	数据

Result«TopicDTO»

json

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": 0,
    "content": "string",
    "imgURLs": [
      "string"
    ],
    "authorID": 0,
    "createdAt": "string",
    "updatedAt": "string",
    "isDraft": true
  }
}

属性

名称	类型	必选	约束	说明
code	integer¦null	false	none	编码：1成功，0和其它数字为失败
msg	string¦null	false	none	错误信息
data	TopicDTO	false	none	数据

MapString

json

{
  "key": "string"
}

属性

名称	类型	必选	约束	中文名	说明
key	string	false	none		none

StudentLoginDTO

json

{
  "code": "string"
}

属性

名称	类型	必选	约束	中文名	说明
code	string	false	none		none

AdminLoginDTO

json

{
  "username": "string",
  "password": "string"
}

属性

名称	类型	必选	约束	中文名	说明
username	string	false	none		用户名
password	string	false	none		密码

TopicUploadDTO

json

{
  "Content": "string",
  "ImgURL": "string"
}

属性

名称	类型	必选	约束	中文名	说明
Content	string¦null	false	none		话题内容
ImgURL	string¦null	false	none		话题图片链接

ResultString

json

{
  "code": 0,
  "msg": "string",
  "data": "string"
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	string	false	none	数据

Object

json

{}

属性

None

key

json

{}

属性

None

json

{}

属性

None

Result

json

{
  "code": 0,
  "msg": "string",
  "data": {}
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	Object	false	none	数据

PageInfoCommentDTO

json

{
  "total": 0,
  "list": [
    {
      "id": 0,
      "topicId": 0,
      "userId": 0,
      "content": "string",
      "parentId": 0,
      "createdAt": "string",
      "updatedAt": "string",
      "user": {
        "id": 0,
        "studentid": 0,
        "username": "string",
        "name": "string",
        "avatar": "string",
        "email": "string",
        "phone": "string",
        "sex": "string",
        "idNumber": "string"
      },
      "replies": [
        {
          "id": 0,
          "topicId": 0,
          "userId": 0,
          "content": "string",
          "parentId": 0,
          "createdAt": "string",
          "updatedAt": "string",
          "user": {
            "id": null,
            "studentid": null,
            "username": null,
            "name": null,
            "avatar": null,
            "email": null,
            "phone": null,
            "sex": null,
            "idNumber": null
          },
          "replies": [
            {}
          ]
        }
      ]
    }
  ],
  "pageNum": 0,
  "pageSize": 0,
  "size": 0,
  "startRow": 0,
  "endRow": 0,
  "pages": 0,
  "prePage": 0,
  "nextPage": 0,
  "isFirstPage": true,
  "isLastPage": true,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "navigatePages": 0,
  "navigatepageNums": [
    0
  ],
  "navigateFirstPage": 0,
  "navigateLastPage": 0
}

属性

名称	类型	必选	约束	说明
total	integer	false	none	none
list	[CommentDTO]	false	none	none
pageNum	integer	false	none	none
pageSize	integer	false	none	none
size	integer	false	none	none
startRow	integer	false	none	none
endRow	integer	false	none	none
pages	integer	false	none	none
prePage	integer	false	none	none
nextPage	integer	false	none	none
isFirstPage	boolean	false	none	none
isLastPage	boolean	false	none	none
hasPreviousPage	boolean	false	none	none
hasNextPage	boolean	false	none	none
navigatePages	integer	false	none	none
navigatepageNums	[integer]	false	none	none
navigateFirstPage	integer	false	none	none
navigateLastPage	integer	false	none	none

MapObject

json

{
  "key": {}
}

属性

名称	类型	必选	约束	中文名	说明
key	key	false	none		none

AdminDTO

json

{
  "id": 0,
  "username": "string",
  "name": "string",
  "phone": "string",
  "sex": "string",
  "idNumber": "string"
}

属性

名称	类型	必选	约束	说明
id	integer	false	none	none
username	string	false	none	none
name	string	false	none	none
phone	string	false	none	none
sex	string	false	none	none
idNumber	string	false	none	none

Student

json

{
  "id": 0,
  "openid": "string",
  "studentid": 0,
  "username": "string",
  "email": "string",
  "phone": "string",
  "sex": "string",
  "idNumber": "string",
  "avatar": "string",
  "createTime": "string",
  "updateTime": "string"
}

属性

名称	类型	必选	约束	说明
id	integer	false	none	none
openid	string	false	none	微信用户唯一标识
studentid	integer	false	none	学号
username	string	false	none	姓名
email	string	false	none	邮箱
phone	string	false	none	手机号
sex	string	false	none	性别 0 女 1 男
idNumber	string	false	none	身份证号
avatar	string	false	none	头像
createTime	string	false	none	注册时间
updateTime	string	false	none	更新时间

Topic

json

{
  "id": 0,
  "content": "string",
  "authorID": 0,
  "imgURLs": [
    "string"
  ],
  "createdAt": "string",
  "updatedAt": "string",
  "isDraft": true
}

属性

名称	类型	必选	约束	说明
id	integer	false	none	none
content	string	false	none	none
authorID	integer	false	none	none
imgURLs	[string]	false	none	none
createdAt	string	false	none	none
updatedAt	string	false	none	none
isDraft	boolean	false	none	none

ResultPageInfoCommentDTO

json

{
  "code": 0,
  "msg": "string",
  "data": {
    "total": 0,
    "list": [
      {
        "id": 0,
        "topicId": 0,
        "userId": 0,
        "content": "string",
        "parentId": 0,
        "createdAt": "string",
        "updatedAt": "string",
        "user": {
          "id": 0,
          "studentid": 0,
          "username": "string",
          "name": "string",
          "avatar": "string",
          "email": "string",
          "phone": "string",
          "sex": "string",
          "idNumber": "string"
        },
        "replies": [
          {
            "id": null,
            "topicId": null,
            "userId": null,
            "content": null,
            "parentId": null,
            "createdAt": null,
            "updatedAt": null,
            "user": null,
            "replies": null
          }
        ]
      }
    ],
    "pageNum": 0,
    "pageSize": 0,
    "size": 0,
    "startRow": 0,
    "endRow": 0,
    "pages": 0,
    "prePage": 0,
    "nextPage": 0,
    "isFirstPage": true,
    "isLastPage": true,
    "hasPreviousPage": true,
    "hasNextPage": true,
    "navigatePages": 0,
    "navigatepageNums": [
      0
    ],
    "navigateFirstPage": 0,
    "navigateLastPage": 0
  }
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	PageInfoCommentDTO	false	none	数据

ResultMapObject

json

{
  "code": 0,
  "msg": "string",
  "data": {
    "key": {}
  }
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	MapObject	false	none	数据

List

json

{}

属性

None

ResultStudent

json

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": 0,
    "openid": "string",
    "studentid": 0,
    "username": "string",
    "email": "string",
    "phone": "string",
    "sex": "string",
    "idNumber": "string",
    "avatar": "string",
    "createTime": "string",
    "updateTime": "string"
  }
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	Student	false	none	数据

StudentDTO

json

{
  "id": 0,
  "studentid": 0,
  "username": "string",
  "name": "string",
  "avatar": "string",
  "email": "string",
  "phone": "string",
  "sex": "string",
  "idNumber": "string"
}

属性

名称	类型	必选	约束	说明
id	integer	false	none	none
studentid	integer	false	none	none
username	string	false	none	none
name	string	false	none	none
avatar	string	false	none	none
email	string	false	none	none
phone	string	false	none	none
sex	string	false	none	none
idNumber	string	false	none	none

ResultTopic

json

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": 0,
    "content": "string",
    "authorID": 0,
    "imgURLs": [
      "string"
    ],
    "createdAt": "string",
    "updatedAt": "string",
    "isDraft": true
  }
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	Topic	false	none	数据

PageResult

json

{
  "total": 0,
  "records": [
    {}
  ]
}

属性

名称	类型	必选	约束	中文名	说明
total	integer	false	none		总记录数
records	[object]	false	none		当前页数据集合

ResultBoolean

json

{
  "code": 0,
  "msg": "string",
  "data": true
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	boolean	false	none	数据

ResultPageResult

json

{
  "code": 0,
  "msg": "string",
  "data": {
    "total": 0,
    "records": [
      {}
    ]
  }
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	PageResult	false	none	数据

CommentDTO

json

{
  "id": 0,
  "topicId": 0,
  "userId": 0,
  "content": "string",
  "parentId": 0,
  "createdAt": "string",
  "updatedAt": "string",
  "user": {
    "id": 0,
    "studentid": 0,
    "username": "string",
    "name": "string",
    "avatar": "string",
    "email": "string",
    "phone": "string",
    "sex": "string",
    "idNumber": "string"
  },
  "replies": [
    {
      "id": 0,
      "topicId": 0,
      "userId": 0,
      "content": "string",
      "parentId": 0,
      "createdAt": "string",
      "updatedAt": "string",
      "user": {
        "id": 0,
        "studentid": 0,
        "username": "string",
        "name": "string",
        "avatar": "string",
        "email": "string",
        "phone": "string",
        "sex": "string",
        "idNumber": "string"
      },
      "replies": [
        {
          "id": 0,
          "topicId": 0,
          "userId": 0,
          "content": "string",
          "parentId": 0,
          "createdAt": "string",
          "updatedAt": "string",
          "user": {
            "id": null,
            "studentid": null,
            "username": null,
            "name": null,
            "avatar": null,
            "email": null,
            "phone": null,
            "sex": null,
            "idNumber": null
          },
          "replies": [
            {}
          ]
        }
      ]
    }
  ]
}

属性

名称	类型	必选	约束	说明
id	integer	false	none	评论ID
topicId	integer	false	none	话题ID
userId	integer	false	none	用户ID
content	string	false	none	评论内容
parentId	integer	false	none	none
createdAt	string	false	none	none
updatedAt	string	false	none	none
user	StudentDTO	false	none	none
replies	[CommentDTO]	false	none	none

Admin

json

{
  "id": 0,
  "username": "string",
  "name": "string",
  "password": "string",
  "phone": "string",
  "sex": "string",
  "idNumber": "string",
  "status": 0,
  "createTime": "string",
  "updateTime": "string",
  "createUser": 0,
  "updateUser": 0
}

属性

名称	类型	必选	约束	说明
id	integer	false	none	none
username	string	false	none	none
name	string	false	none	none
password	string	false	none	none
phone	string	false	none	none
sex	string	false	none	none
idNumber	string	false	none	none
status	integer	false	none	none
createTime	string	false	none	@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
updateTime	string	false	none	@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
createUser	integer	false	none	none
updateUser	integer	false	none	none

ResultAdmin

json

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": 0,
    "username": "string",
    "name": "string",
    "password": "string",
    "phone": "string",
    "sex": "string",
    "idNumber": "string",
    "status": 0,
    "createTime": "string",
    "updateTime": "string",
    "createUser": 0,
    "updateUser": 0
  }
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	Admin	false	none	数据

PageResultTopic

json

{
  "total": 0,
  "records": [
    {
      "id": 0,
      "content": "string",
      "authorID": 0,
      "imgURLs": [
        "string"
      ],
      "createdAt": "string",
      "updatedAt": "string",
      "isDraft": true
    }
  ]
}

属性

名称	类型	必选	约束	中文名	说明
total	integer	false	none		none
records	[Topic]	false	none		none

ResultPageResultTopic

json

{
  "code": 0,
  "msg": "string",
  "data": {
    "total": 0,
    "records": [
      {
        "id": 0,
        "content": "string",
        "authorID": 0,
        "imgURLs": [
          "string"
        ],
        "createdAt": "string",
        "updatedAt": "string",
        "isDraft": true
      }
    ]
  }
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	PageResultTopic	false	none	数据

API 设计 ​

用户端公共接口 ​

POST 学生上传文件 ​

请求参数 ​

返回结果 ​

POST 学生删除文件 ​

请求参数 ​

返回结果 ​

用户端学生接口 ​

POST 微信登录 ​

请求参数 ​

返回结果 ​

POST 微信获取手机号 ​

请求参数 ​

返回结果 ​

GET 获取当前用户信息 ​

请求参数 ​

返回结果 ​

GET 获取学生信息 ​

请求参数 ​

返回结果 ​

GET 根据id获取学生信息 ​

请求参数 ​

返回结果 ​

GET 根据用户名获取学生信息 ​

请求参数 ​

返回结果 ​

PUT 更新学生信息 ​

请求参数 ​

返回结果 ​

GET 获取发布的帖子（分页） ​

请求参数 ​

返回结果 ​

GET 获取评论的帖子（分页） ​

请求参数 ​

返回结果 ​

GET 获取收藏的帖子（分页） ​

请求参数 ​

返回结果 ​

用户端话题接口 ​

POST 创建话题 ​

请求参数 ​

返回结果 ​

DELETE 删除话题 ​

请求参数 ​

返回结果 ​

POST 新建草稿 ​

请求参数 ​

返回结果 ​

GET 获取草稿 ​

请求参数 ​

返回结果 ​

DELETE 删除草稿 ​

请求参数 ​

返回结果 ​

GET 检查是否存在草稿 ​

请求参数 ​

返回结果 ​

GET 实现话题无限滚动 ​

请求参数 ​

返回结果 ​

GET 根据id获取话题详情 ​

请求参数 ​

返回结果 ​

POST 点赞话题 ​

请求参数 ​

返回结果 ​

POST 取消点赞话题 ​

请求参数 ​

返回结果 ​

GET 是否点赞话题 ​

请求参数 ​

返回结果 ​

GET 获取点赞计数 ​

请求参数 ​

返回结果 ​

POST 收藏话题 ​

请求参数 ​

返回结果 ​

POST 取消收藏话题 ​

API 设计

用户端公共接口

POST 学生上传文件

请求参数

返回结果

POST 学生删除文件

请求参数

返回结果

用户端学生接口

POST 微信登录

请求参数

返回结果

POST 微信获取手机号

请求参数

返回结果

GET 获取当前用户信息

请求参数

返回结果

GET 获取学生信息

请求参数

返回结果

GET 根据id获取学生信息

请求参数

返回结果

GET 根据用户名获取学生信息

请求参数

返回结果

PUT 更新学生信息

请求参数

返回结果

GET 获取发布的帖子（分页）

请求参数

返回结果

GET 获取评论的帖子（分页）

请求参数

返回结果

GET 获取收藏的帖子（分页）

请求参数

返回结果

用户端话题接口

POST 创建话题

请求参数

返回结果

DELETE 删除话题

请求参数

返回结果

POST 新建草稿

请求参数

返回结果

GET 获取草稿

请求参数

返回结果

DELETE 删除草稿

请求参数

返回结果

GET 检查是否存在草稿

请求参数

返回结果

GET 实现话题无限滚动

请求参数

返回结果

GET 根据id获取话题详情

请求参数

返回结果

POST 点赞话题

请求参数

返回结果

POST 取消点赞话题

请求参数

返回结果

GET 是否点赞话题

请求参数

返回结果

GET 获取点赞计数

请求参数

返回结果

POST 收藏话题

请求参数

返回结果

POST 取消收藏话题