使用 Express 和 waterline 创建简单 Restful API

最近想重写一下网站的Restful API,原来是用PHP写的,看到现在nodejs这么火也想试一下,虽然了解过nodejs但真正动手写还是头一次,找了好多教程来看然后试着敲下一代码,这篇文件主要参考了

Build a RESTful API Using Node and Express 4
https://scotch.io/tutorials/build-a-restful-api-using-node-and-express-4

原文里用的是MongoDB,考虑到我用的数据库是Mysql,所以我把CRUD部分的操作改成了MySql的,

1. 环境的搭建

nodejs的安装我就是不说了,我主要采用了以下Node package

  • Express 4.0
    nodejs下最出名的web 框架了

  • waterline
    ORM数据操作中间件,官方团队提供的适配器:提供了对 MySQL / MongoDB / Redis 的支持,也有很多第三方开发的适配器。

  • sails-mysql
    这个是waterline 官方提供的对MySQL的adapter

package.json 内容

{
  "name": "node-api",
  "version": "1.0.0",
  "description": "node api learn",
  "main": "server.js",
  "dependencies": {
    "body-parser": "^1.15.0",
    "express": "^4.13.4",
    "sails-mysql": "^0.12.1",
    "waterline": "^0.12.1"
  },
  "devDependencies": {
    "nodemon": "^1.9.1"
  }
}

运行

npm install

安装所需要的所有package

首先让 express 先跑起来

// server.js


var express    = require('express');     
var app        = express();                 
var bodyParser = require('body-parser');

app.use(bodyParser.urlencoded({ extended: true }));
app.use(bodyParser.json());

var port = process.env.PORT || 8080;        

var router = express.Router();             

router.get('/', function(req, res) {
    res.json({ message: 'hello! welcome to our api!' });   
});

app.use('/api', router);


app.listen(port);
console.log('Magic happens on port ' + port);

在控制台运行

node server.js

测试一下程序的运行效果

因为要调试restful API 所以推荐使用POSTMAN 一款chrome下专门用来调试restful api的工具

POSTMAN界面

在地址栏里输入 http://localhost:8080/api/

图片描述

可以看到,服务器已经正常启用了。接下来就是要做一些CRUD,的操作了.

2. 数据库的创建

为了保持代码的清析和可理解,所以为测试代码创建的数据库很简单:

CREATE TABLE `bear` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `name` varchar(255) DEFAULT NULL
  PRIMARY KEY (`id`)
) ENGINE=MyISAM AUTO_INCREMENT=9 DEFAULT CHARSET=latin1;

就一个int id 自增型主键字段 和一个 varchar(255) 的name字段,方便编码。

定义一个的model在主目录下创建一个app/models/bear.js

//app/models/bear.js

var Waterline = require('waterline');

module.exports = Waterline.Collection.extend({
    identity:'bear',  //模型名,默认对应表名,你也可以通过tableName 属性来配置对应的表名
    connection:'myLocalMysql',//所采有的数据库连接
    schema: true,
    attributes:{
        name:'string'
    }
});

更详细的models说明,清参见:https://github.com/balderdashy/waterline-docs/blob/master/models/models.md

在创建一个数据库链接配置文件 app/config/waterline.js

//app/config/waterline.js
var mysqlAdapter = require('sails-mysql');

var wlconfig = {
    adapters: {
        'default':mysqlAdapter,
        mysql: mysqlAdapter
    },

    connections: {
        myLocalMysql: { //对应models中的connection
            adapter : 'mysql',
            host : 'localhost',
            port : 3306,
            user : 'root',
            password : '',
            database : 'test'
        }
    },

    defaults: {
        migrate: 'safe' //这个注意啊,如果是争对已经有的数据库一定要注意,小心把表全删除了
    }
};

exports.config = wlconfig;

然后回到server.js引入相关文件

//server.js

var Waterline    = require('waterline');

var Bear         = require('./app/models/bear');
var WConfig = require('./app/config/waterline');

var orm = new Waterline();
orm.loadCollection(Bear);

........
........

//把start server的代码改为

orm.initialize(WConfig.config,function(err,models){
    if(err) throw err;
    app.models = models.collections;
    //app.set('models',models.collections);
    app.connections = models.connections;

    app.listen(port);

    console.log('Magic happens on port ' + port);
});

3. 定义路由

//server.js

...

var port = process.env.PORT || 8080;

var router = express.Router();

router.use(function(req,res,next) {
    console.log('Something is happening.');
    next();
}); 

router.get('/', function(req,res) {
    res.json({ message: 'Hello! welcome to our api! '});
});

...

app.use('/api',router);

使用 express.Router() 来创建路由并增加一个中间件,这里我们只是让它简单的在控制台输出一句 Something is happening.'

POST /API/BEARS

router.route('/bears')
    .post(function(req,res) {
        app.models.bear.create(req.body,function(err,model) {
            if(err) return res.json({ err,err }, 500);
            res.json(model);
        });
    });

用POSTMAN测试一下

图片描述

完美,不过怎么多了两个字段 createAt 和 updateAt查了文档才知道,这就是一开始的时候我没有把
migrate:设为 'safe', 不过也可以在models里关闭 autoCreatedAt:false 就可以了

GET /API/BEARS

//server.js
.post(function(req,res) {
        app.models.bear.create(req.body,function(err,model) {
            if(err) return res.json({ err,err }, 500);
            res.json(model);
        });
    })
.get(function(req,res) {
        app.models.bear.find().exec(function(err,model){
            if(err) return res.json({ err: err },500);
            res.json(model);
        });
    });

通过id进行查改删

router.route('/bears/:bear_id')
    .get(function(req,res) {
        app.models.bear.findOne({ id: req.params.bear_id},function(err,model) {
            if(err) return res.json({ err:err },500);
            res.json(model);
        });
    })

    .put(function(req,res) {

        delete req.body.id;
        app.models.bear.update({ id: req.params.bear_id},req.body, function(err,model) {
            if(err) return res.json({ err: err},500);
            res.json(model);
        });
    })

    .delete(function(req,res) {
        app.models.bear.destroy({ id: req.params.bear_id},function(err,model) {
            if(err) return res.json({err: err},500);
            res.json({ status:'ok'});
        });
    });

总结

整个过程应该是比较简单的,由于没有涉及业务逻辑部分,所以也没有碰到什么坑,但作为一个基本入门还是比较简洁清晰的。


papersnake
papersnake的自我成长

最近比较空

11.1k 声望
1.7k 粉丝
0 条评论
推荐阅读
U8G2自定义中文字库的方法
使用U8G2库来做为Oled显示,但是中文支持不够用,打算使用自己建的中文字库 需要的材料和工具: .map文件 .pdf文件(字体文件) bdfconv.exe(u8g2自带) 文本与unicode码转换小工具 TTF to BDF工具 otf2bdf(u8g2 git...

papersnake阅读 8.4k

正则表达式实例
收集在业务中经常使用的正则表达式实例,方便以后进行查找,减少工作量。常用正则表达式实例1. 校验基本日期格式 {代码...} {代码...} 2. 校验密码强度密码的强度必须是包含大小写字母和数字的组合,不能使用特殊...

寒青56阅读 8.4k评论 11

JavaScript有用的代码片段和trick
平时工作过程中可以用到的实用代码集棉。判断对象否为空 {代码...} 浮点数取整 {代码...} 注意:前三种方法只适用于32个位整数,对于负数的处理上和Math.floor是不同的。 {代码...} 生成6位数字验证码 {代码...} ...

jenemy48阅读 6.9k评论 12

从零搭建 Node.js 企业级 Web 服务器(十五):总结与展望
总结截止到本章 “从零搭建 Node.js 企业级 Web 服务器” 主题共计 16 章内容就更新完毕了,回顾第零章曾写道:搭建一个 Node.js 企业级 Web 服务器并非难事,只是必须做好几个关键事项这几件必须做好的关键事项就...

乌柏木75阅读 7k评论 16

再也不学AJAX了!(二)使用AJAX ① XMLHttpRequest
「再也不学 AJAX 了」是一个以 AJAX 为主题的系列文章,希望读者通过阅读本系列文章,能够对 AJAX 技术有更加深入的认识和理解,从此能够再也不用专门学习 AJAX。本篇文章为该系列的第二篇,最近更新于 2023 年 1...

libinfs42阅读 6.8k评论 12

封面图
从零搭建 Node.js 企业级 Web 服务器(一):接口与分层
分层规范从本章起,正式进入企业级 Web 服务器核心内容。通常,一块完整的业务逻辑是由视图层、控制层、服务层、模型层共同定义与实现的,如下图:从上至下,抽象层次逐渐加深。从下至上,业务细节逐渐清晰。视图...

乌柏木45阅读 8.5k评论 6

从零搭建 Node.js 企业级 Web 服务器(二):校验
校验就是对输入条件的约束,避免无效的输入引起异常。Web 系统的用户输入主要为编辑与提交各类表单,一方面校验要做在编辑表单字段与提交的时候,另一方面接收表单的接口也要做足校验行为,通过前后端共同控制输...

乌柏木35阅读 6.6k评论 10

最近比较空

11.1k 声望
1.7k 粉丝
宣传栏