W.T.的博客

Every day to be a little better

大事件后台管理开发-api说明

发表于 更新于 分类于
本文字数： 11k 阅读时长 ≈ 10 分钟
路由访问说明

1. 说明

  1. 项目的请求根路径为 http://127.0.0.1:3007
  2. 以 /api 开头的请求路径，不需要访问权限
  3. 以 /my 开头的请求路径，需要在请求头中携带 Authorization 身份认证字段，才能正常访问成功

2. 登录注册

2.1. 注册 /api/reguser

简要描述：

  • 用户注册接口

请求URL：

  • /api/reguser

请求方式：

  • POST

请求体：

参数名 必选 类型 说明
username 是 string 用户名
password 是 string 密码

返回示例

1
2
3
4
{
  "status": 0,
  "message": "注册成功！"
}

返回参数说明

参数名 类型 说明
status int 请求是否成功，0：成功；1：失败
message string 请求结果的描述消息

2.2. 登录 /api/login

简要描述：

  • 用户登录接口

请求URL：

  • /api/login

请求方式：

  • POST

请求体：

参数名 必选 类型 说明
username 是 string 用户名
password 是 string 密码

返回示例

1
2
3
4
5
{
  "status": 0,
  "message": "登录成功！",
  "token": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInBhc3N3b3JkIjoiIiwibmlja25hbWUiOiLms6Xlt7Tlt7QiLCJlbWFpbCI6Im5pYmFiYUBpdGNhc3QuY24iLCJ1c2VyX3BpYyI6IiIsImlhdCI6MTU3ODAzNjY4MiwiZXhwIjoxNTc4MDcyNjgyfQ.Mwq7GqCxJPK-EA8LNrtMG04llKdZ33S9KBL3XeuBxuI"
}

返回参数说明

参数名 类型 说明
status int 请求是否成功，0：成功；1：失败
message string 请求结果的描述消息
token string 用于有权限接口的身份认证

3. 个人中心

3.1. 获取用户的基本信息 /my/userinfo

简要描述：

  • 获取用户的基本信息

请求URL：

  • /my/userinfo

请求方式：

  • GET

Header：

1
Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInBhc3N3b3JkIjoiIiwibmlja25hbWUiOiLms6Xlt7Tlt7QiLCJlbWFpbCI6Im5pYmFiYUBpdGNhc3QuY24iLCJ1c2VyX3BpYyI6IiIsImlhdCI6MTU3ODAzNjY4MiwiZXhwIjoxNTc4MDcyNjgyfQ.Mwq7GqCxJPK-EA8LNrtMG04llKdZ33S9KBL3XeuBxuI

参数：

  • 无

返回示例

1
2
3
4
5
6
7
8
9
10
11
{
  "status": 0,
  "message": "获取用户基本信息成功！",
  "data": {
    "id": 1,
    "username": "admin",
    "nickname": "管理员",
    "email": "admin@itcast.cn",
    "user_pic": ""
  }
}

返回参数说明

参数名 类型 说明
status int 请求是否成功，0：成功；1：失败
message string 请求结果的描述消息
data object 用户的基本信息
+ id int 用户的 id
+ username string 用户名
+ nickname string 昵称
+ email string 邮箱
+ user_pic string 头像，base64格式的图片

3.2. 更新用户的基本信息 /my/userinfo

简要描述：

  • 更新用户的基本信息

请求URL：

  • /my/userinfo

请求方式：

  • POST

Header：

1
Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInBhc3N3b3JkIjoiIiwibmlja25hbWUiOiLms6Xlt7Tlt7QiLCJlbWFpbCI6Im5pYmFiYUBpdGNhc3QuY24iLCJ1c2VyX3BpYyI6IiIsImlhdCI6MTU3ODAzNjY4MiwiZXhwIjoxNTc4MDcyNjgyfQ.Mwq7GqCxJPK-EA8LNrtMG04llKdZ33S9KBL3XeuBxuI

请求体：

参数名 必选 类型 说明
id 是 number 用户id
nickname 是 string 昵称
email 是 string 邮箱

返回示例

1
2
3
4
{
  "status": 0,
  "message": "修改用户信息成功！"
}

返回参数说明

参数名 类型 说明
status int 请求是否成功，0：成功；1：失败
message string 请求结果的描述消息

3.3. 重置密码 /my/updatepwd

简要描述：

  • 重置密码

请求URL：

  • /my/updatepwd

请求方式：

  • POST

Header：

1
Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInBhc3N3b3JkIjoiIiwibmlja25hbWUiOiLms6Xlt7Tlt7QiLCJlbWFpbCI6Im5pYmFiYUBpdGNhc3QuY24iLCJ1c2VyX3BpYyI6IiIsImlhdCI6MTU3ODAzNjY4MiwiZXhwIjoxNTc4MDcyNjgyfQ.Mwq7GqCxJPK-EA8LNrtMG04llKdZ33S9KBL3XeuBxuI

请求体：

参数名 必选 类型 说明
oldPwd 是 string 原密码
newPwd 是 string 新密码

返回示例

1
2
3
4
{
  "status": 0,
  "message": "更新密码成功！"
}

返回参数说明

参数名 类型 说明
status int 请求是否成功，0：成功；1：失败
message string 请求结果的描述消息

3.4. 更换头像 /my/update/avatar

简要描述：

  • 更换头像

请求URL：

  • /my/update/avatar

请求方式：

  • POST

Header：

1
Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInBhc3N3b3JkIjoiIiwibmlja25hbWUiOiLms6Xlt7Tlt7QiLCJlbWFpbCI6Im5pYmFiYUBpdGNhc3QuY24iLCJ1c2VyX3BpYyI6IiIsImlhdCI6MTU3ODAzNjY4MiwiZXhwIjoxNTc4MDcyNjgyfQ.Mwq7GqCxJPK-EA8LNrtMG04llKdZ33S9KBL3XeuBxuI

请求体：

参数名 必选 类型 说明
avatar 是 string 新头像，base64格式的字符串

返回示例

1
2
3
4
{
  "status": 0,
  "message": "更新头像成功！"
}

返回参数说明

参数名 类型 说明
status int 请求是否成功，0：成功；1：失败
message string 请求结果的描述消息

4. 文章类别管理

4.1. 获取文章分类列表/my/article/cates

简要描述：

  • 获取文章分类列表

请求URL：

  • /my/article/cates

请求方式：

  • GET

Header：

1
Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInBhc3N3b3JkIjoiIiwibmlja25hbWUiOiLms6Xlt7Tlt7QiLCJlbWFpbCI6Im5pYmFiYUBpdGNhc3QuY24iLCJ1c2VyX3BpYyI6IiIsImlhdCI6MTU3ODAzNjY4MiwiZXhwIjoxNTc4MDcyNjgyfQ.Mwq7GqCxJPK-EA8LNrtMG04llKdZ33S9KBL3XeuBxuI

参数：

  • 无

返回示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
{
  "status": 0,
  "message": "获取文章分类列表成功！",
  "data": [
    {
      "Id": 1,
      "name": "最新",
      "alias": "ZuiXin",
      "is_delete": 0
    },
    {
      "Id": 2,
      "name": "科技",
      "alias": "KeJi",
      "is_delete": 0
    },
    {
      "Id": 3,
      "name": "股市",
      "alias": "GuShi",
      "is_delete": 0
    },
    {
      "Id": 4,
      "name": "历史",
      "alias": "LiShi",
      "is_delete": 0
    },
    {
      "Id": 5,
      "name": "情感",
      "alias": "QingGan",
      "is_delete": 0
    }
  ]
}

返回参数说明

参数名 类型 说明
status int 请求是否成功，0：成功；1：失败
message string 请求结果的描述消息
data array 文章分类的数组
+ Id int 分类 Id
+ name string 分类名称
+ alias string 分类别名
+ is_delete int 是否被删除，0：未删除；1：已删除

4.2. 新增文章分类/my/article/addcates

简要描述：

  • 新增文章分类

请求URL：

  • /my/article/addcates

请求方式：

  • POST

Header：

1
Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInBhc3N3b3JkIjoiIiwibmlja25hbWUiOiLms6Xlt7Tlt7QiLCJlbWFpbCI6Im5pYmFiYUBpdGNhc3QuY24iLCJ1c2VyX3BpYyI6IiIsImlhdCI6MTU3ODAzNjY4MiwiZXhwIjoxNTc4MDcyNjgyfQ.Mwq7GqCxJPK-EA8LNrtMG04llKdZ33S9KBL3XeuBxuI

请求体：

参数名 必选 类型 说明
name 是 string 分类名称
alias 是 string 分类别名

返回示例

1
2
3
4
{
  "status": 0,
  "message": "新增文章分类成功！"
}

返回参数说明

参数名 类型 说明
status int 请求是否成功，0：成功；1：失败
message string 请求结果的描述消息

4.3. 根据 Id 删除文章分类/my/article/deletecate/:id

简要描述：

  • 根据 Id 删除文章分类

请求URL：

  • /my/article/deletecate/:id

请求方式：

  • GET

Header：

1
Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInBhc3N3b3JkIjoiIiwibmlja25hbWUiOiLms6Xlt7Tlt7QiLCJlbWFpbCI6Im5pYmFiYUBpdGNhc3QuY24iLCJ1c2VyX3BpYyI6IiIsImlhdCI6MTU3ODAzNjY4MiwiZXhwIjoxNTc4MDcyNjgyfQ.Mwq7GqCxJPK-EA8LNrtMG04llKdZ33S9KBL3XeuBxuI

URL 参数：

参数名 必选 类型 说明
id 是 string 要删除的分类 Id，注意：这是一个URL参数

返回示例

1
2
3
4
{
  "status": 0,
  "message": "删除文章分类成功！"
}

返回参数说明

参数名 类型 说明
status int 请求是否成功，0：成功；1：失败
message string 请求结果的描述消息

备注

  • API 接口不允许删除 最新 和 科技 这两个文章分类!

4.4. 根据 Id 获取文章分类数据 /my/article/cates/:id

简要描述：

  • 根据 Id 获取文章分类数据

请求URL：

  • /my/article/cates/:id

请求方式：

  • GET

Header：

1
Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInBhc3N3b3JkIjoiIiwibmlja25hbWUiOiLms6Xlt7Tlt7QiLCJlbWFpbCI6Im5pYmFiYUBpdGNhc3QuY24iLCJ1c2VyX3BpYyI6IiIsImlhdCI6MTU3ODAzNjY4MiwiZXhwIjoxNTc4MDcyNjgyfQ.Mwq7GqCxJPK-EA8LNrtMG04llKdZ33S9KBL3XeuBxuI

URL 参数：

参数名 必选 类型 说明
id 是 string 分类的 Id，注意：这是一个URL参数

返回示例

1
2
3
4
5
6
7
8
9
10
{
  "status": 0,
  "message": "获取文章分类数据成功！",
  "data": {
    "Id": 1,
    "name": "最新",
    "alias": "ZuiXin",
    "is_delete": 0
  }
}

返回参数说明

参数名 类型 说明
status int 请求是否成功，0：成功；1：失败
message string 请求结果的描述消息
data object 文章分类的信息对象
Id int 分类 Id
name string 分类名称
alias string 分类别名
is_delete int 是否被删除，0：未删除；1：删除

4.5. 根据 Id 更新文章分类数据 /my/article/updatecate

简要描述：

  • 根据 Id 更新文章分类数据

请求URL：

  • /my/article/updatecate

请求方式：

  • POST

Header：

1
Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInBhc3N3b3JkIjoiIiwibmlja25hbWUiOiLms6Xlt7Tlt7QiLCJlbWFpbCI6Im5pYmFiYUBpdGNhc3QuY24iLCJ1c2VyX3BpYyI6IiIsImlhdCI6MTU3ODAzNjY4MiwiZXhwIjoxNTc4MDcyNjgyfQ.Mwq7GqCxJPK-EA8LNrtMG04llKdZ33S9KBL3XeuBxuI

请求体：

参数名 必选 类型 说明
Id 是 int 分类 Id
name 是 string 分类名称
alias 是 string 分类别名

返回示例

1
2
3
4
{
  "status": 0,
  "message": "更新分类信息成功！"
}

返回参数说明

参数名 类型 说明
status int 请求是否成功，0：成功；1：失败
message string 请求结果的描述消息

5. 文章管理

5.1. 发布新文章/my/article/add

简要描述：

  • 发布新文章

请求URL：

  • /my/article/add

请求方式：

  • POST

请求体（FormData 格式）：

参数名 必选 类型 说明
title 是 string 文章标题
cate_id 是 int 所属分类 Id
content 是 string 文章内容
cover_img 是 blob二进制 文章封面
state 是 string 状态，可选值为：已发布、草稿

返回示例

1
2
3
4
{
    status: 0,
    message: '发布文章成功！'
}

返回参数说明

参数名 类型 说明
status int 请求是否成功，0：成功；1：失败
message string 请求结果的描述消息

备注

  • 由于此接口涉及到文件上传的功能，因此提交的请求体，必须是 FormData 格式！

5.2. 获取文章的列表数据/my/article/list

简要描述：

  • 获取文章的列表数据

请求URL：

  • /my/article/list

请求方式：

  • GET

Header：

1
Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInBhc3N3b3JkIjoiIiwibmlja25hbWUiOiLms6Xlt7Tlt7QiLCJlbWFpbCI6Im5pYmFiYUBpdGNhc3QuY24iLCJ1c2VyX3BpYyI6IiIsImlhdCI6MTU3ODAzNjY4MiwiZXhwIjoxNTc4MDcyNjgyfQ.Mwq7GqCxJPK-EA8LNrtMG04llKdZ33S9KBL3XeuBxuI

参数：

参数名 必选 类型 说明
pagenum 是 int 页码值
pagesize 是 int 每页显示多少条数据
cate_id 否 string 文章分类的 Id
state 否 string 文章的状态，可选值有：已发布、草稿

返回示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "status": 0,
  "message": "获取文章列表成功！",
  "data": [
    {
      "Id": 1,
      "title": "abab",
      "pub_date": "2020-01-03 12:19:57.690",
      "state": "已发布",
      "cate_name": "最新"
    },
    {
      "Id": 2,
      "title": "666",
      "pub_date": "2020-01-03 12:20:19.817",
      "state": "已发布",
      "cate_name": "股市"
    }
  ],
  "total": 5
}

返回参数说明

参数名 类型 说明
status int 请求是否成功，0：成功；1：失败
message string 请求结果的描述消息
data array 文章的数组
+ Id int 文章 Id
+ title string 标题
+ pub_date string 发表时间
+ state string 状态
+ cate_name string 所属分类名称

5.3. 根据 Id 删除文章数据/my/article/delete/:id

简要描述：

  • 根据 Id 删除文章数据

请求URL：

  • /my/article/delete/:id

请求方式：

  • GET

Header：

1
Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInBhc3N3b3JkIjoiIiwibmlja25hbWUiOiLms6Xlt7Tlt7QiLCJlbWFpbCI6Im5pYmFiYUBpdGNhc3QuY24iLCJ1c2VyX3BpYyI6IiIsImlhdCI6MTU3ODAzNjY4MiwiZXhwIjoxNTc4MDcyNjgyfQ.Mwq7GqCxJPK-EA8LNrtMG04llKdZ33S9KBL3XeuBxuI

URL 参数：

参数名 必选 类型 说明
id 是 string 要删除的文章 Id，注意：这是一个URL参数

返回示例

1
2
3
4
{
  "status": 0,
  "message": "删除成功！"
}

返回参数说明

参数名 类型 说明
status int 请求是否成功，0：成功；1：失败
message string 请求结果的描述消息

5.4. 根据 Id 获取文章详情/my/article/:id

简要描述：

  • 根据 Id 获取文章详情

请求URL：

  • /my/article/:id

请求方式：

  • GET

Header：

1
Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInBhc3N3b3JkIjoiIiwibmlja25hbWUiOiLms6Xlt7Tlt7QiLCJlbWFpbCI6Im5pYmFiYUBpdGNhc3QuY24iLCJ1c2VyX3BpYyI6IiIsImlhdCI6MTU3ODAzNjY4MiwiZXhwIjoxNTc4MDcyNjgyfQ.Mwq7GqCxJPK-EA8LNrtMG04llKdZ33S9KBL3XeuBxuI

URL 参数：

参数名 必选 类型 说明
id 是 string 文章的 Id，注意：这是一个URL参数

返回示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "status": 0,
  "message": "获取文章成功！",
  "data": {
    "Id": 4,
    "title": "新地球",
    "content": "<p><span style=\"color: #0000ff;\"><em><strong>新地球，人们很骄傲</strong></em></span></p>",
    "cover_img": "\\uploads\\upload_1cbcb854da97eb04d808cddb40dd3954",
    "pub_date": "2020-01-03 12:23:01.903",
    "state": "草稿",
    "is_delete": 0,
    "cate_id": 2,
    "author_id": 1
  }
}

返回参数说明

参数名 类型 说明
status int 请求是否成功，0：成功；1：失败
message string 请求结果的描述消息
data object 文章的详情
+ Id int 文章 Id
+ title string 标题
+ content string 内容
+ cover_img string 封面的URL地址
+ pub_date string 发表时间
+ state string 状态
+ is_delete int 是否被删除
+ cate_id int 所属分类 Id
+ author_id int 所属作者 Id

5.5. 根据 Id 更新文章信息 /my/article/edit

简要描述：

  • 根据 Id 更新文章信息

请求URL：

  • /my/article/edit

请求方式：

  • POST

请求体（FormData 格式）：

参数名 必选 类型 说明
Id 是 int 文章 Id
title 是 string 文章标题
cate_id 是 int 所属分类 Id
content 是 string 文章内容
cover_img 是 blob二进制 文章封面
state 是 string 状态，可选值为：已发布、草稿

返回示例

1
2
3
4
{
    status: 0,
    message: '修改文章成功！'
}

返回参数说明

参数名 类型 说明
status int 请求是否成功，0：成功；1：失败
message string 请求结果的描述消息

备注

  • 由于此接口涉及到文件上传的功能，因此提交的请求体，必须是 FormData 格式！
本文结束  感谢您的阅读