# 接口文档
# 接口规约
起始点:http://host:port/api/v1
起始点 + 类型 + 终结点 得出最终链接,如:http://host:port/api/v1/register/send-mail-verify 为发送邮箱验证码
**注意终结点为 ` ` 和终结点为 `/` 是两个路径** ,例如: http://host:port/api/v1/user 和 http://host:port/api/v1/user/ 分别代表两个不同的东西,不能视为同等请求。
## 数据类型模板
| 字段名 | 数据类型 | 默认值 | 说明 |
| :-------: | :------: | :-----: | :----------: |
| `code` | int | 200 | 响应状态码 |
| `message` | string | success | 响应信息 |
| `data` | object | null | 响应数据 |
| `status` | bool | true | 操作是否成功 |
### `code `含义
| 取值范围 | 含义 |
| :-------: | :------------: |
| [200,299] | 请求成功 |
| [300,399] | 请求转发 |
| [400,499] | 用户级请求失败 |
| 401 | 未登录,请先登录 |
| 402 | 非法操作 |
| [500,599] | 系统级请求失败 |
用户级请求失败:由用户的操作造成,一般是操作被拒绝、跨权限访问或异常操作,比如注册账号时的用户名被占用或者是未经登录就调用修改信息的接口。此类请求一般可以直接将异常信息展示给用户。
系统级请求失败:由服务器异常造成,比如某段代码报错但未经正确处理。此类请求一般不将异常信息直接展示给用户。
## 请求方式说明
一般情况下,各接口的请求方式遵循以下表格:
| 请求方式 | 传参方式 | 含义 |
| :------: | :------: | :----------------: |
| GET | url | 获取资源 |
| POST | fromdata | 新建资源、发出动作 |
| PUT | fromdata | 更新资源 |
| DELETE | fromdata | 删除资源 |
# 注册相关 `/register`
## 发送邮箱验证码 `√`
**注册邮箱验证码有90s发送一次的限制**
终结点:`/send-mail-verify`
请求方式:`POST`
**参数**
| 字段名 | 数据类型 | 默认值 | 说明 |
| :----: | :------: | :----: | :------: |
| `mail` | string | - | 用户邮箱 |
**响应数据**
无
## 提交注册 `√`
终结点:`/register`
请求方式:`POST`
**参数**
| 字段名 | 数据类型 | 默认值 | 说明 |
| :----------: | :------: | :----: | :--------: |
| `username` | string | - | 用户名 |
| `password` | string | - | 密码 |
| `mail` | string | - | 邮箱 |
| `mailVerify` | string | - | 邮箱验证码 |
| `mobile` | string | - | 手机号 |
**响应数据**
无
# 登录相关 `/login`
## 用户登录 `√`
终结点:`/login`
请求方式:`POST`
**参数**
| 字段名 | 数据类型 | 默认值 | 说明 |
| :--------: | :------: | :----: | :----: |
| `username` | string | - | 用户名 |
| `password` | string | - | 密码 |
**响应数据**
| 字段名 | 数据类型 | 说明 |
| :------------: | :------: | :------: |
| `username` | string | 用户名 |
| `nickname` | string | 昵称 |
| `avatarUrl` | string | 头像链接 |
| `registerTime` | datatime | 注册时间 |
## 用户登出 `√`
终结点:`/logout`
请求方式:`GET`
**参数**
无
**响应数据**
无
# 用户信息相关`/user`
==**注意:此类型下所有方法均需要登录后才可以成功调用,除非有特殊说明**==
## 获取公开信息 `√`
**该接口无需登录,可以获取任意用户的信息,如果只需要获取当前用户的信息,请不要传参数**
终结点:` `
请求方式:`GET`
**参数**
| 字段名 | 数据类型 | 默认值 | 说明 |
| :--------: | :------: | :------------: | :----: |
| `username` | string | 当前登录用户名 | 用户名 |
**响应数据**
| 字段名 | 数据类型 | 说明 |
| :------------: | :------: | :------: |
| `username` | string | 用户名 |
| `nickname` | string | 昵称 |
| `avatarUrl` | datatime | 头像链接 |
| `registerTime` | datatime | 注册时间 |
## 修改昵称 `√`
终结点:`/nickname`
请求方式:`PUT`
**参数**
| 字段名 | 数据类型 | 默认值 | 说明 |
| :--------: | :------: | :----: | :------: |
| `nickname` | string | - | 用户昵称 |
**响应数据**
无
## 修改头像 `√`
**上传的文件请小于1Mib,支持的格式:png、jpg、jpeg**
终结点:`/avatar`
请求方式:`PUT`
**参数**
| 字段名 | 数据类型 | 默认值 | 说明 |
| :----------: | :------: | :----: | :------: |
| `avatarFile` | file | - | 用户头像 |
**响应数据**
无
## 修改密码 `√`
终结点:`/password`
请求方式:`PUT`
**参数**
| 字段名 | 数据类型 | 默认值 | 说明 |
| :-----------: | :------: | :----: | :----: |
| `oldPassword` | string | - | 旧密码 |
| `newPassword` | string | - | 新密码 |
**响应数据**
无
## 修改邮箱 `√`
**修改邮箱前需要先发送邮箱验证码**
终结点:`/mail`
请求方式:`PUT`
**参数**
| 字段名 | 数据类型 | 默认值 | 说明 |
| :----------: | :------: | :----: | :--------: |
| `mail` | string | - | 新邮箱 |
| `mailVerify` | string | - | 邮箱验证码 |
**响应数据**
无
## 发送邮箱验证码 `√`
**该邮箱验证码有60s内只能发送一次的限制**
终结点:`/mail/send-mail-verify`
请求方式:`POST`
**参数**
无
**响应数据**
无
## 获取基本信息
## 修改基本信息
## 获取教育信息
## 修改教育信息
## 删除用户 `√`
终结点:`/user`
请求方式:`DELETE`
**参数**
| 字段名 | 数据类型 | 默认值 | 说明 |
| :--------: | :------: | :----: |:-----:|
| `password` | string | - | 密码 |
**响应数据**
无
# 关注和粉丝
## 获取关注列表
### 请求信息
#### 请求地址
```
/user/follow?page=98
```
#### 请求方法
```
GET
```
#### 入参字段说明
| **字段** | **类型** | **必填** | **含义** | **其他参考信息** |
| -------- | -------- | -------- | -------- | ---------------- |
| page | **int** | 否 | 当前页 | |
### 出参
#### 出参示例
```json
{
"code": 110,
"message": "响应信息36",
"data": {
"records": [
{
"id": 28,
"userId": 90,
"followId": 4,
"note": "备注21",
"status": 59,
"createTime": {
"nanos": 60
},
"username": "关注者用户名52",
"nickname": "关注者昵称62",
"avatarUrl": "关注者头像链接114",
"registerTime": {}
},
{
"id": 28,
"userId": 90,
"followId": 4,
"note": "备注21",
"status": 59,
"createTime": {
"nanos": 60
},
"username": "关注者用户名52",
"nickname": "关注者昵称62",
"avatarUrl": "关注者头像链接114",
"registerTime": {}
}
],
"total": 920,
"size": 538,
"current": 298
},
"status": true
}
```
#### 出参字段说明
| **字段** | **类型** | **含义** | **其他参考信息** |
| -------------------------------------------------------- |------------------------- | ------------------------------------- | --------------- | | code
| **Integer** | 状态码 | | | message | **String** | 响应信息 | | | data | **
ListVO\<FollowBasic\>** | 响应数据 | | | └─ records | **
List\<FollowBasic\>** | 查询数据列表 | | |     └─ id | **
Integer** | id | | |     └─ userId | **
Integer** | 用户i
没有合适的资源?快使用搜索试试~ 我知道了~
温馨提示
校园博客,基于微服务架构且前后端分离的博客社区系统。项目后端技术栈:SpringBoot + SpringCloud + Mybatis-Plus + Nacos + MySQL + Redis + MQ + ElasticSearch + Docker。 项目特点 微服务架构开发,友好的代码结构及注释,便于阅读及二次开发 前后端分离,通过 Json 进行数据交互,前端无需关注后端技术 采用 Nacos 作为服务注册中心,支持分布式集群架构,方便微服务配置管理 采用 Getaway 搭建网关服务,进行负载转发的同时对用户身份进行识别,并支持配置接口未认证拦截功能 采用 JWT 的方式进行用户鉴权,配合网关服务保证其他所有微服务都能准确识别用户身份 采用 Minio 搭建对象存储服务,同时引入七牛云对象存储 采用 AOP + 自定义注解 + Redis 实现限制IP接口访问次数 基于 Redis 实现的分布式全局唯一ID生成器,保障ID可用性、安全性。 页面交互使用 Vue2.x,极大的提高了开发效率
资源推荐
资源详情
资源评论
收起资源包目录
本科毕业设计+校园博客,基于微服务架构且前后端分离的博客社区系统 SpringBoot +MySQL+MQ+Node.js (455个子文件)
topbar.css 82KB
demo.css 8KB
normalize.css 6KB
iconfont.css 2KB
base.css 1KB
icon.css 115B
Dockerfile 546B
Dockerfile 546B
Dockerfile 546B
Dockerfile 546B
Dockerfile 546B
Dockerfile 546B
Dockerfile 546B
.editorconfig 145B
spring.factories 169B
spring.factories 126B
spring.factories 125B
spring.factories 113B
spring.factories 111B
spring.factories 107B
spring.factories 107B
gift.gif 41KB
.gitignore 614B
.gitignore 254B
demo_index.html 27KB
index.html 1KB
favicon.ico 8KB
BlogServiceImpl.java 11KB
BlogViewServiceImpl.java 9KB
RankServiceImpl.java 8KB
UserServiceImpl.java 8KB
CommentServiceImpl.java 8KB
RedisCache.java 7KB
VisitRecordService.java 6KB
RegisterServiceImpl.java 6KB
BlogConsoleController.java 5KB
BlogListener.java 5KB
UserController.java 5KB
MinioServiceImpl.java 4KB
DefaultExceptionAdvice.java 4KB
CollectBlogServiceImpl.java 4KB
RequestUtils.java 4KB
LikeBlogServiceImpl.java 4KB
ImageServiceImpl.java 4KB
TimeUtils.java 3KB
RequestLimitAspect.java 3KB
MinioService.java 3KB
FileUtils.java 3KB
UserFollowServiceImpl.java 3KB
BlinkViewServiceImpl.java 3KB
BlogListener.java 3KB
MailService.java 3KB
BaseException.java 3KB
BlogController.java 3KB
UserService.java 3KB
BlinkController.java 3KB
BlogContentServiceImpl.java 3KB
UserGeneralScheduleTask.java 3KB
CommentListener.java 2KB
JwtUtils.java 2KB
PathMatcherFilter.java 2KB
JwtUtils.java 2KB
IpLimitFilter.java 2KB
AuthorizeFilter.java 2KB
BlinkServiceImpl.java 2KB
QiNiuServiceImpl.java 2KB
DefaultResponseAdvice.java 2KB
BlogActionController.java 2KB
BlogServerListener.java 2KB
FollowController.java 2KB
GlobalExceptionHandler.java 2KB
CommentListener.java 2KB
BlogViewService.java 2KB
BlogDoc.java 2KB
UserClientResolver.java 2KB
RestResult.java 2KB
RedisSimpleLock.java 2KB
UniversityServiceImpl.java 2KB
MonoUtils.java 2KB
BlogGeneralMapper.java 2KB
LoginServiceImpl.java 2KB
UserClient.java 2KB
UserGeneralMapper.java 2KB
UploadController.java 2KB
BlogService.java 2KB
BlogRepository.java 2KB
AuthHelper.java 2KB
LoginController.java 2KB
UniversityController.java 2KB
FileType.java 2KB
ResourceClient.java 1KB
CommentController.java 1KB
XssFilter.java 1KB
UserSafetyMapper.java 1KB
ResourceClientFuse.java 1KB
RedisSerializeDefaultConfig.java 1KB
BlogRankController.java 1KB
RedisIdGenerator.java 1KB
BlogMqConstants.java 1KB
RankService.java 1KB
共 455 条
- 1
- 2
- 3
- 4
- 5
资源评论
白话机器学习
- 粉丝: 8191
- 资源: 7687
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
最新资源
- 解决未在远程桌面会话中捕获到鼠标,vmguest.iso软件分享给大家
- JSP+SQL基于WEB的开放性实验管理系统设计与实现(源代码+论文+开题报告+中英文献+答辩PPT).rar
- log4net配置文件!!!!!!!!!!!!!!!!!
- 河南统计面板数据集(2010-2022年).xlsx
- OrcaleDBHelper帮助类!!!!!!!!!!!!
- log4net帮助类,用来写日志!!!!!!!!!!!!!
- Windows10时间同步源
- 信呼OA系统2.1.7版源码
- 3122080306 邹子轩 实验报告二.docx
- 基于STM32 NUCLEO板设计彩色LED照明灯(纯cubeMX开发)(大赛作品,文档完整,可直接运行)
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功