使用 Express 和 waterline 創建簡單 Restful API

這幾篇都是我原來首發在 segmentfault 上的地址：https://segmentfault.com/a/1190000004996659 

突然想起來我這個博客冷落了好多年了，也該更新一下，呵呵 

最近想重寫一下網站的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.0nodejs下最出名的web 框架了

• waterlineORM數據操作中間件，官方團隊提供的適配器：提供了對 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的工具

在地址欄里輸入 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'}); }); }); 

總結

整個過程應該是比較簡單的，由於沒有涉及業務邏輯部分，所以也沒有碰到什么坑，但作為一個基本入門還是比較簡潔清晰的。