nodejs + mongodb 编写 restful 风格博客 api

简介

搭建一个restful风格的个人博客api。restful风格：就是使用同一个接口，通过不同的请求方式例如post，get，put，delete等实现数据的增删查改等。

需要的工具

• node
• Postman或者其他接口测试工具

用到的模块介绍

• express : nodejs框架
• mongoose : 用来方便的和mongodb交互
• body-parser : 方便我们从post请求中解析参数
• morgan : 把请求信息打印在控制台
• jsonwebtoken : 用来生成和确认token数据

主要操作流程

1.新建一个项目文件夹，使用npm初始化

1. npm init -y

2.手动输入依赖环境，或者npm install直接安装

1. cnpm install --save express mongoose body-parser morgan jsonwebtoken
2. cnpm install

3.新建所需要的文件夹以及文件，目录结构如下

1. app/
2. -----models/                //模块
3. ----------blog.js
4. ----------category.js
5. ----------user.js
6. -----routes/                //路由
7. ----------blog.js
8. ----------category.js
9. ----------comment.js
10. ----------setup.js
11. ----------user.js
12. -node_modules/              //依赖环境安装后生成
13. -config.js                  //一些配置
14. -package.json               //项目依赖环境(初始化后自动生成)
15. -server.js                  //项目启动文件

基础代码如下

modules/ 模块文件

主要就是导出各种模板供启动文件server.js调用

user.js user模块

1. var mongoose = require('mongoose'); //引入mongoose依赖
2. var Schema = mongoose.Schema;//mongoose的一切都是以Schema开始的
4. // 使用modules.exports导出User模块
5. module.exports = mongoose.model('User',new Schema({//利用模板的方式启动模板，并导出
6.    name:String,
7.    password:String,
8.    admin:Boolean
9. }))

category.js

1. var mongoose = require('mongoose');
2. var Schema = mongoose.Schema;
4. module.exports = mongoose.model('Category',new Schema({
5.    title:String
6. }))

blog.js blog 模块

1. var mongoose = require('mongoose');
2. var Schema = mongoose.Schema;
4. module.exports = mongoose.model('Blog',new Schema({
5.    title: String,
6.    body:String,
7.    antuor:String,
8.    category:String,
9.    comment:[{body: String,date:Date}],
10.    tags:[{title:String}],
11.    date:{type:Date,default:Date.now},
12.    hidden:Boolean,
13.    mete:{
14.        vores:Number,
15.        favs:Number
16.    }
17. }))

config.js

内容为各种配置

1. module.exports = {
2.    'secret':'zp,zp',    
3.    'database':'mongodb://127.0.0.1'
4. }

说明：

• secret的值可以随便取，主要是用来生成token时用的
• 数据库设置要连接数据库的信息

server.js

这是最基本的启动文件

1. var express = require('express');
2. var app = express();
3. var bodyParser = require('body-parser');
4. var morgan = require('morgan');
5. var mongoose = require('mongoose');
7. var jwt = require('jsonwebtoken');//用来创建和确认用户信息摘要
8. var config = require('./config'); //读取配置文件config.js信息
10. //一些配置
11. var port = process.env.PORT || 8080; // 设置启动端口
12. mongoose.connect(config.database); // 连接数据库
13. app.set('superSecret', config.secret); // 设置app 的超级密码--用来生成摘要的密码
15. //用body parser 来解析post和url信息中的参数
16. app.use(bodyParser.urlencoded({extended: false}));
17. app.use(bodyParser.json());
19. // 使用 morgan 将请求日志打印到控制台
20. app.use(morgan('dev'));
22. //路由
23. //基础路由
24. app.get('/',function(req,res){
25.    res.send("这里是nodejs+mongodb编写restfulAPI的笔记！");
26. })
29. // 启动服务
30. app.listen(port);
31. console.log('Magic happens at http://localhost:' + port);

先来测试一下，测试之前先开启mongodb，用postman进行测试：

开始接口编写

第一个接口 创建管理员

routes/setup.js

1. var express = require("express");
2. var User = require("../modules/user");
4. var router = express.Router();
6. router.get('/',function(req,res){
8.    var admin = new User({
9.        name:'zhoupeng1',
10.        password:'12345',
11.        admin:true
12.    })      //创建一个管理员
14.    admin.save(function(err){
15.        if(err){
16.            res.json({
17.                success:false,
18.                message:'管理员创建失败'
19.            });
20.        }
21.        res.json({success:true,message:"管理员创建成功"})
23.    })          //加入数据库，并判断是否成功
24. })
26. module.exports = router; //导出路由

然后server.js中导入路由文件，添加下面两句：

1. var setupRoute = require('./app/routes/setup');// 导入路由文件
3. app.use('/setup',setupRoute);   //设置访问路径

测试：

第二个接口 管理员登录

routes/user.js

1. var express = require('express');
2. var app = express();//定义app
3. var User = require("../modules/user")
5. var jwt = require('jsonwebtoken');//用来创建和确认用户信息摘要
6. var config = require('../../config');
7. app.set('superSecret', config.secret); // 设置app 的超级密码--用来生成摘要的密码
9. var router = express.Router();
11. router.post('/login',function(req,res){
12.    User.findOne({
13.        name:req.body.name //根据用户输入用户名进行匹配
14.    },function(err,user){   //登录验证
15.        if(err){
16.            res.json({success:false,message:"登录失败"});
17.        };
19.        if(!user){
20.            res.json({success:false,message:"认证失败，用户名找不到"});
21.        }else if(user){
22.            if(user.password != req.body.password){
23.                res.json({success:false,message:"认证失败，密码错误"});
24.            }else{
25.                var token = jwt.sign({name:'foo'},app.get('superSecret'));//获取token
26.                res.json({
27.                    success:true,
28.                    message:"恭喜，登录成功",
29.                    token:token
30.                })
31.            }
32.        }
33.    })
34. })

然后server.js中导入路由文件，添加下面两句：

1. var userRoute = require('./app/routes/user');// 导入路由文件
3. app.use('/user',userRoute);   //设置访问路径

测试：

第三个接口 博客分类的增删查改

routes/category.js

1. var express = require('express');
2. var Category = require('../modules/category')
3. var router = express.Router();
5. // 添加分类
6. router.post('/',function(req,res){
7.    var title = req.body.title;
8.    console.log(req);
9.    var category = new Category({
10.        title:title
11.    })
12.    category.save(function(err){
13.        if(err){
14.            res.json({
15.                success:false,
16.                message:"添加分类成功！"
17.            })
18.        }
19.    })
20.    res.json({success:true,message:"添加分类成功！"})
21. })
23. // 查看所有分类
24. router.get('/',function(req,res){
25.    Category.find({},function(err,categories){
26.        res.json({
27.            success:true,
28.            data:categories
29.        })
30.    })
31. })
33. // 更新分类
34. router.put('/',function(req,res){
36.    // 解构赋值
37.    var {title,newTitle} = req.body;
38.    Category.findOneAndUpdate({title:title},{title:newTitle},function(err,category){
39.        if(err){
40.            res.json({
41.                success:false,message:"更新分类失败"
42.            })
43.        }
44.    })
45.    res.json({success:true,message:"更新分类成功！"})
46. })
48. // 删除分类
49. router.delete('/',function(req,res){
50.    console.log('delete category');
52.    // 解构赋值
53.    var {title} = req.body;
55.    Category.remove({title:title},function(err){
56.        if(err){
57.            res.json({
58.                success:false,messge:"删除分类成功！"
59.            })
60.        }
61.    })
62.    res.json({success:true,message:"删除分类成功！"})
63. })
65. module.exports = router;

然后server.js中导入路由文件，添加下面两句：

1. var categoryRoute = require('./app/routes/category');// 导入路由文件
3. app.use('/category',categoryRoute);   //设置访问路径

测试添加分类，查询分类：

测试更新分类 首先多添加几条数据，便于查看：

测试删除分类： 

第四个接口，博客的编写

routes/blog.js

1. var express = require("express");
2. var Blog = require("../modules/blog");
4. var router = express.Router();
7. // 显示所有博客
8. router.get('/',function(req,res){
9.    // 根据分类查找
10.    var {category} = req.query;
11.    var whereObj = {};
12.    if(category){
13.        var reg = new RegExp('^'+category+'$');
14.        whereObj = {category:reg}
15.    }
16.    //var reg = new RegExp('^'+category+'$')与/^category$/的区别
17.    //前者中的category是拼接上的一个变量，是动态的，
18.    //后者是静态的只能匹配'category'这个内容
20.    Blog.find(whereObj,function(err,blogs){
21.        res.json({
22.            success:true,
23.            data:blogs
24.        })
25.    })
26. })
28. // 发布博客
29. router.post('/',function(req,res){
30.    // 结构赋值
31.    var {title,body,author,tags,hidden,category} = req.body;
32.    console.log(title);
33.    if(title.length<3){
34.        res.json({
35.            success:false,
36.            message:"标题长度不能小于3"
37.        })
38.    }
40.    // 标签格式应该是对象数组
42.    // 把标签分割成数组格式
43.    var tagsArray = tags.split(",");
44.    // 新建一个空数组，用来放对象
45.    var tagsObjArray = [];
46.    // 通过遍历的方式，把标签内容放入对象里面，通过push方式
47.    tagsArray.forEach(function(v){
48.        tagsObjArray.push({title:v});
49.    })
51.    var blog = new Blog({
52.        title,
53.        body,
54.        author,
55.        tags:tagsObjArray,
56.        hidden,
57.        category
58.    });
60.   blog.save(function(err){
61.       if(err){
62.           res.json({success:false,messafe:"博客发布失败"})
63.       };
64.       res.json({success:true,message:"博客发布成功"})
65.   })
66. })
68. // 修改博客
69. router.put('/',function(){
70.    var {title,newTitle,body,newBody,author,newAuthor} = req.body;
71.    if(newTitle.length<3){
72.        res.json({
73.            success:false,
74.            message:"标题长度不能小于3"
75.        })
76.    }
77.    blog.update({
78.        title:title,
79.        body:body,
80.        author:author
81.    },{
82.        title:newTitle,
83.        body:newBody,
84.        author:newAuthor
85.    },function(err,blog){
86.        if(err){
87.            res.json({
88.                success:false,
89.                message:"更新博客失败"
90.            })
91.        }
92.    });
93.    res.json({
94.        success:true,
95.        message:"更新博客成功"
96.    })
98. })
100. // 删除博客
101. router.delete('/',function(req,res){
103.    // 解构赋值
104.    var {title} = req.body;
106.    Blog.remove({
107.        title:title,
108.    },function(err){
109.        if(err){
110.            res.json({
111.                success:false,messge:"删除博客失败！"
112.            })
113.        }
114.    })
115.    res.json({success:true,message:"删除博客成功！"})
116. })
118. module.exports = router;

然后server.js中导入路由文件，添加下面两句：

1. var blogRoute = require('./app/routes/blog');// 导入路由文件
3. app.use('/blog',blogRoute);   //设置访问路径

本文章转载微信公众号@SegmentFault思否