title: 个人博客 v1.0.0
language_tabs:
- shell: Shell
- http: HTTP
- javascript: JavaScript
- ruby: Ruby
- python: Python
- php: PHP
- java: Java
- go: Go
toc_footers: []
includes: []
search: true
highlight_theme: darkula
headingLevel: 2
个人博客
v1.0.0
Default
POST 登录
POST /api/login
Body 请求参数
type: object
properties:
username:
type: string
description: 用户名
example: admin
password:
type: string
description: 密码
example: "1314521999"
required:
- username
- password
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| body | body | object | false | none |
| » username | body | string | true | 用户名 |
| » password | body | string | true | 密码 |
返回示例
成功
{
"status": 0,
"message": "登陆成功！",
"userInfo": {
"user_id": 15,
"username": "admin",
"password": "",
"nickname": "辰漪",
"user_pic": "https://wrz521.top:8080/uploads/art_cover-2021-09-13 16-56-36.png",
"is_admin": 1,
"is_use": 1,
"reg_time": "2021-08-26T08:08:08.000Z"
},
"token": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxNSwidXNlcm5hbWUiOiJhZG1pbiIsInBhc3N3b3JkIjoiIiwibmlja25hbWUiOiLovrDmvKoiLCJ1c2VyX3BpYyI6Imh0dHBzOi8vd3J6NTIxLnRvcDo4MDgwL3VwbG9hZHMvYXJ0X2NvdmVyLTIwMjEtMDktMTMgMTYtNTYtMzYucG5nIiwiaXNfYWRtaW4iOjEsImlzX3VzZSI6MSwicmVnX3RpbWUiOiIyMDIxLTA4LTI2VDA4OjA4OjA4LjAwMFoiLCJpYXQiOjE2NDAxNDk4MjcsImV4cCI6MTY0MDE4NTgyN30.bXcGc-iMvVhICfF64EWpBZcQxETbkCFqWORnRgiCnCg"
}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
| » status | integer | true | none | 是否成功 0 成功 1 失败 |
| » message | string | true | none | 说明信息 |
| » userInfo | object | true | none | 用户信息 |
| »» user_id | integer | true | none | 用户id |
| »» username | string | true | none | 用户名 |
| »» password | string | true | none | 密码 |
| »» nickname | string | true | none | 昵称 |
| »» user_pic | string | true | none | 用户头像 |
| »» is_admin | integer | true | none | 是否管理员 |
| »» is_use | integer | true | none | 能否使用 |
| »» reg_time | string | true | none | 注册时间 |
| » token | string | true | none | token |
blog
GET 获取用户信息列表分页
GET /my/getUserListPage
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| fuzzy | query | string | false | 查询字符串（通过username 或者 nickname）可以传空 获取全部 |
| pageNum | query | string | false | 当前页码（默认 1） |
| pageSize | query | string | false | 每页显示条数（默认 10） |
| sortKey | query | string | false | 根据哪个字段排序 |
| sortValue | query | string | false | desc降序 asc升序 |
| Authorization | header | string | true | none |
返回示例
成功
{
"status": 0,
"msg": "获取用户列表成功！",
"total": 6,
"data": [
{
"user_id": 44,
"username": "admin3",
"nickname": "辰漪3",
"user_pic": "3",
"is_admin": 0,
"is_use": 1,
"reg_time": "2022-01-13T05:44:04.000Z"
},
{
"user_id": 43,
"username": "admin2",
"nickname": "辰漪1",
"user_pic": "1",
"is_admin": 0,
"is_use": 1,
"reg_time": "2022-01-12T06:22:14.000Z"
},
{
"user_id": 39,
"username": "admin11561",
"nickname": null,
"user_pic": null,
"is_admin": 0,
"is_use": 1,
"reg_time": "2022-01-11T07:25:21.000Z"
},
{
"user_id": 30,
"username": "admin1",
"nickname": null,
"user_pic": null,
"is_admin": 0,
"is_use": 1,
"reg_time": "2022-01-11T06:44:05.000Z"
},
{
"user_id": 26,
"username": "admin",
"nickname": null,
"user_pic": null,
"is_admin": 0,
"is_use": 1,
"reg_time": "2022-01-11T06:35:04.000Z"
},
{
"user_id": 16,
"username": "123",
"nickname": null,
"user_pic": null,
"is_admin": 0,
"is_use": 1,
"reg_time": "2022-01-11T06:06:24.000Z"
}
]
}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
| » status | integer | true | none | none |
| » msg | string | true | none | none |
| » total | integer | true | none | none |
| » data | [object] | true | none | none |
| »» user_id | integer | true | none | none |
| »» username | string | true | none | none |
| »» nickname | string¦null | true | none | none |
| »» user_pic | string¦null | true | none | none |
| »» is_admin | integer | true | none | none |
| »» is_use | integer | true | none | none |
| »» reg_time | string | true | none | none |
POST 用户注册
POST /api/reguser
Body 请求参数
type: object
properties:
username:
type: string
description: 用户名
password:
type: string
description: 密码
required:
- username
- password
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| body | body | object | false | none |
| » username | body | string | true | 用户名 |
| » password | body | string | true | 密码 |
返回示例
成功
{
"status": 0,
"msg": "注册成功！"
}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
| » status | integer | true | none | none |
| » msg | string | true | none | none |
POST 文件上传
POST /my/uploads
Body 请求参数
type: object
properties:
avatar:
type: string
description: 要上传的文件信息
format: binary
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| Authorization | header | string | true | 身份认证 |
| body | body | object | false | none |
| » avatar | body | string(binary) | false | 要上传的文件信息 |
返回示例
成功
{
"status": 0,
"fileInfo": {
"fieldname": "avatar",
"originalname": "g.png",
"encoding": "7bit",
"mimetype": "image/png",
"destination": "./uploads",
"filename": "avatar-2022-01-20 14-43-33.png",
"path": "/uploads/avatar-2022-01-20 14-43-33.png",
"size": 19531
},
"msg": "上传成功！"
}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
| » status | integer | true | none | none |
| » fileInfo | object | true | none | none |
| »» fieldname | string | true | none | none |
| »» originalname | string | true | none | none |
| »» encoding | string | true | none | none |
| »» mimetype | string | true | none | none |
| »» destination | string | true | none | none |
| »» filename | string | true | none | none |
| »» path | string | true | none | none |
| »» size | integer | true | none | none |
| » msg | string | true | none | none |
PUT 更新用户基本资料
PUT /my/updateInfo
Body 请求参数
type: object
properties:
nickname:
type: string
description: 昵称
user_pic:
type: string
description: 头像
is_admin:
type: string
description: 是否管理员
is_use:
type: string
description: 账号是否可用
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| user_id | query | string | true | 用户id |
| Authorization | header | string | true | token |
| body | body | object | false | none |
| » nickname | body | string | false | 昵称 |
| » user_pic | body | string | false | 头像 |
| » is_admin | body | string | false | 是否管理员 |
| » is_use | body | string | false | 账号是否可用 |
返回示例
成功
{
"status": 0,
"msg": "修改成功！"
}返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
| » status | integer | true | none | none |
| » msg | string | true | none | none |
PUT 修改密码
PUT /my/updatePwd
Body 请求参数
type: object
properties:
currentPwd:
type: string
description: 当前密码
editPwd:
type: string
description: 要修改的密码
repeatPwd:
type: string
description: 重复密码
required:
- currentPwd
- editPwd
- repeatPwd
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| user_id | query | string | true | 用户id |
| Authorization | header | string | true | token |
| body | body | object | false | none |
| » currentPwd | body | string | true | 当前密码 |
| » editPwd | body | string | true | 要修改的密码 |
| » repeatPwd | body | string | true | 重复密码 |
返回示例
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 失败 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
| » status | integer | true | none | none |
| » msg | string | true | none | none |
数据模型
© 版权声明
文章版权归作者所有，未经允许请勿转载。
THE END
- 最新
- 最热
只看作者