前端Vue，后端Express，数据库Mongodb
vue-express-mongdb-blog文章管理系统的后端系统， 带有登录注册及相关中间件、权限区别、分页搜索、增删改查文章功能等api接口;
npm install
node index.js
该分支为纯服务器， 整合前端项目的版本可查看release分支
项目目录结构:
├─.gitignore
├─config ------------------ // 配置文件
│ ├─auth.config.js -------- // ！！ 自定义秘钥(在控制模块中配合jsonwebtoken生成登录后的有效期一天的accessToken)
│ └─db.config.js ---------- // 配置连接mongodb数据库的url，在index.js中配合mongoose连接云端(服务器AWS Singapore )的mongodb数据库
├─controllers ------------- // 控制模块
│ ├─auth.controller.js ---- // 登录验证(！！！ 使用jsonwebtoken及自定的秘钥生成accessToken，有效期设置为一天)、注册验证(引用中间件的注册验证模块，若注册成功则使用bcryptjs将密码转码保存至数据库，保证安全)
│ ├─post.controller.js ---- // ！！ 定义文章API请求函数，对数据库的文章信息进行操作
│ └─user.controller.js ---- // 用户函数，对应不同权限(如user、admin等)返回不同内容
├─index.js
├─middlewares ------------- // 中间件模块
│ ├─authJwt.js ------------ // ！！ 权限验证，验证请求是否有有效的token，及与请求内容相对应的用户权限(user、admin等)
│ ├─index.js -------------- // 入口文件
│ └─verifySignUp.js ------- // 注册验证，防止重复用户名、邮箱或者用户权限重复
├─models ------------------ // 模型类
│ ├─index.js -------------- // 入口文件
│ ├─post.model.js --------- // 文章Model类
│ ├─role.model.js --------- // 角色Model类
│ └─user.model.js --------- // 用户Model类
├─package-lock.json
├─package.json
├─README.md
└─routes ------------------ // 路由模块
├─auth.routes.js -------- // 注册验证，检验是否已存在相同用户名或邮箱，或者该用户已存在想要添加的权限
├─post.routes.js -------- // ！！文章API请求接口，详情请看https://github.com/hjwforever/vue-express-mongdb-blog-server/tree/main#%E2%85%B2-api
└─user.routes.js -------- // 用户路由，根据用户权限(user、admin等)返回不停内容
正常运行后即可以 BASEURL = http://localhost:8080/api/ 为基路由发起api请求, 以下为具体接口:
path: posts
eg.
http://localhost:8080/api/posts
requestBody:
{
"title":"Test 5", // 文章标题
"author":"aruoxi", // 文章作者
"content":"This is a test by hjw" // 文章内容
}method:
POST
description:
创建新文章
response body:
{
"likes": [], // 点赞用户id列表
"title": "Test 5", // 文章标题
"author": "aruoxi", // 文章作者
"content": "This is a test by hjw", // 文章内容
"createdAt": "2020-12-07T05:47:47.419Z", // 文章创建时间
"updatedAt": "2020-12-07T05:47:47.419Z", // 文章更新时间
"id": "5fcdc203b013491f4c8b8470" // 文章id
}分页获取文章(分页查找, 当size= 'all' 时查询所有文章)
path:
posts[?page=page[&size=size]]
eg. http://localhost:8080/api/posts?page=3&size=6
method:
GET
description:
获取指定id的文章 response body:
{
"totalItems": 53, // 文章总数
"posts": [
{post1}, //省略, 具体格式可参考下一个接口的response body
{post2},
{post3}
],
"totalPages": 9, // 总页数
"currentPage": 3 // 当前页数, 从0开始计数, 即urrentPage=3为第四页
}path:
posts/:id
eg. http://localhost:8080/api/posts/5fcc868cf5c2372360e43366
method:
GET
description:
获取指定id的文章
response body:
{
"likes": [ //点赞用户id列表
"5fc3385a8aaaa83f10b8269d",
"5fc75475f179e724d80a38bb",
"5fc8bbfa3b47062168dd26b7",
"5fc9053d3b47062168dd26c8"
],
"title": "Test 2", //文章标题
"author": "hjw", //文章作者
"content": "This is a test by hjw", //文章内容
"createdAt": "2020-12-06T07:21:48.756Z", //文章创建时间
"updatedAt": "2020-12-06T15:30:40.955Z", //文章更新时间
"id": "5fcc868cf5c2372360e43366" //文章id
}path:
posts/:id
eg. http://localhost:8080/api/posts/5fc8844baf55d7238c21ff4a
requestBody:
{
"title":"Test 1", // 文章标题
"author":"hjw", // 文章作者
"content":"This is a update test by hjw" // 文章内容
}method:
PUT
description:
更新指定id的文章
response body:
{ "message": "Post was updated successfully." }path:
post/like
eg.
http://localhost:8080/api/post/like
requestBody:
{
"id": "5fcc868cf5c2372360e43366", // 文章id
"userId": "5fc338708aaaa83f10b8269e", // 用户id
【"unlike": true】(defalut in server: "unlike": false ) // 是否为取消点赞操作
}method:
PUT
description:
点赞或取消点赞
response body:
【"unlike": false】: //点赞
{
"message": "successfully, The User(id=5fc338708aaaa83f10b8269e) liked the Post(id=5fcc868cf5c2372360e43366)!"
}
【"unlike": true】: // 取消点赞
{
"message": "successfully, The User(id=5fc338708aaaa83f10b8269e) unliked the Post(id=5fcc868cf5c2372360e43366)!"
}path:
posts
eg.
http://localhost:8080/api/posts
method:
DELETE
description:
删除所有文章
response body:
{
"message": "55 Posts were deleted successfully!" //多少篇文章被删除
}
path:
posts/:id
eg.
http://localhost:8080/api/posts/5fce10b8b0505f25d8037988
method:
DELETE
description:
删除指定id的文章
response body:
{
"message": "Post was deleted successfully!" //文章被成功删除
}