项目地址
https://github.com/LoveLosita/message-board
为啥之前啥也没发,现在突然发个项目?
大一刚刚开始一个月,经过各种探索,尝试过python人工智能开发,科研和水味太浓,不太喜欢;又想去算法,结果数学基础不太够,又被击溃。最后,我又加入了我们学校红岩网校的后端和前端,发现前端也很恶心,后端很合我口味,于是就开始跟着学后端。
网校的后端学习节奏还是很快的,给你看看一学期的课程安排:
简直就是特种兵速度。现在我做的这个项目正是第七节课的项目。
哎,希望我能坚持下去吧,不然我也不知道学啥了。
以下是接口文档
1.接口文档
(1)用户相关
用户注册
- 接口名称: 用户注册
- 接口地址:
/user/register
- 请求方式:
POST
,key
:Content-Type
,Value
:application/json
- 请求参数:
请求参数 | 类型 | json中名称 | 是否必需 |
---|---|---|---|
登录用户名 | string | username | yes |
密码 | string | password | yes |
权限 | string | role (包括"admin"和"user") | yes |
用户名(对外展示的) | string | nickname | yes |
请求示例:
{ "username":"test", "password":"1234567", "role":"user", "nickname":"test" }
响应示例:(返回的状态码和下面status相同)
注册成功:{ "status": 200, "info": "OK" }
用户名重复(用户名不可用):
{ "status": 400, "info": "invalid username" }
其他错误(例如操作数据库等等错误)会在info中展示:
{ "status": 500, "info": "error..." }
用户登录
- 接口名称: 用户登录
- 接口地址:
/user/login
- 请求方式:
POST
,key
:Content-Type
,Value
:application/json
- 请求参数:
请求参数 | 类型 | json中名称 | 是否必需 |
---|---|---|---|
登录用户名 | string | username | yes |
密码 | string | password | yes |
请求示例:
{ "username":"test", "password":"1234567" }
响应示例:(返回的状态码和下面status相同)
登录成功:{ "status": 200, "info": "OK" }
密码错误:
{ "status": 400, "info": "Wrong Password!" }
其他错误(例如操作数据库等等错误)会在info中展示:
{ "status": 500, "info": "error..." }
(2)留言相关
发送留言
- 接口名称: 发送留言
- 接口地址:
/message/submit
- 请求方式:
POST
,key
:Content-Type
,Value
:application/json
- 请求参数:
请求参数 | 类型 | json中名称 | 是否必需 |
---|---|---|---|
用户id | int | userid | yes |
留言内容 | string | content | yes |
请求示例:
{ "userid": 1, "content": "这还是一条测试消息~" }
响应示例:(返回的状态码和下面status相同)
发送成功:{ "status": 200, "info": "OK" }
用户名无效:
{ "status": 400, "info": "invalid userid" }
其他错误(例如操作数据库等等错误)会在info中展示:
{ "status": 500, "info": "error..." }
查看所有留言
- 接口名称: 查看所有留言
- 接口地址:
/admin/message/get-all
(管理员专用功能,为后期鉴权做准备) - 请求方式:
GET
- 请求参数: 无
- 请求示例:
http://127.0.0.1:8888/admin/message/get-all
响应示例:(返回的状态码和下面status相同)
获取成功:{ "messages": [ { "id": 2, "userid": 1, "content": "这还是一条测试消息~", "created_at": "2024-12-03T22:27:09+08:00", "updated-at": "2024-12-03T22:27:09+08:00", "is_deleted": 0, "parent_id": null }, { "id": 3, "userid": 1, "content": "这就就是一条测试消息~", "created_at": "2024-12-05T16:24:05+08:00", "updated-at": "2024-12-05T16:24:05+08:00", "is_deleted": 0, "parent_id": null }, { "id": 4, "userid": 2, "content": "这就就是一条测试消息~", "created_at": "2024-12-05T16:25:16+08:00", "updated-at": "2024-12-05T16:29:07+08:00", "is_deleted": 0, "parent_id": null }, { "id": 5, "userid": 2, "content": "这就就111是一条测试消息~", "created_at": "2024-12-05T16:31:15+08:00", "updated-at": "2024-12-05T16:31:15+08:00", "is_deleted": 0, "parent_id": null } ], "respond code": { "status": 200, "info": "OK" } }
其他错误(例如操作数据库等等错误)会在info中展示:
{ "status": 500, "info": "error..." }
删除留言
- 接口名称: 删除留言
- 接口地址:
/admin/message/delete
- 请求方式:
DELETE
,key
:Content-Type
,Value
:application/json
请求参数:
请求参数 类型 json中名称 是否必需 留言id int id yes 请求示例:
{ "id":1 }
响应示例:(返回的状态码和下面status相同)
删除成功:{ "status": 200, "info": "message deleted successfully" }
留言id无效(找不到留言或者留言已经删除):
{ "status": 404, "info": "can't find this message" }
其他错误(例如操作数据库等等错误)会在info中展示:
{ "status": 500, "info": "error..." }