当前位置: 首页 > news >正文

使用 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'}); }); }); 

总结

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

相关文章:

  • lduan SCVMM 2012 AD部署环境(一)
  • Multi-Mechanize工程目录结构说明
  • 统计当前在线用户数量
  • QT多线程类数组同时开启几十个线程
  • 实体ip 虚拟ip 固定ip 动态ip
  • 3 - Components
  • ceph 手工部署集群
  • 转载:align
  • codewars020: The Clockwise Spiral 数字顺时针螺旋矩阵
  • Servlet引擎Jetty之入门1
  • PHP SPL中提供了SplFileInfo和SplFileObject两个类来处理文件操作。
  • pg_dump实例详解(备份postgresql和greenplum数据库)
  • GATK使用说明(一)
  • linux应用之apache的源码安装(centos)
  • linux sudo 命令
  • Angular4 模板式表单用法以及验证
  • Apache的80端口被占用以及访问时报错403
  • eclipse(luna)创建web工程
  • FineReport中如何实现自动滚屏效果
  • MySQL几个简单SQL的优化
  • Netty+SpringBoot+FastDFS+Html5实现聊天App(六)
  • PHP的Ev教程三(Periodic watcher)
  • Spring思维导图,让Spring不再难懂(mvc篇)
  • vue-loader 源码解析系列之 selector
  • 从setTimeout-setInterval看JS线程
  • 代理模式
  • 给新手的新浪微博 SDK 集成教程【一】
  • 关键词挖掘技术哪家强(一)基于node.js技术开发一个关键字查询工具
  • 前端每日实战 2018 年 7 月份项目汇总(共 29 个项目)
  • 入门到放弃node系列之Hello Word篇
  • 手写双向链表LinkedList的几个常用功能
  • 问:在指定的JSON数据中(最外层是数组)根据指定条件拿到匹配到的结果
  • 怎样选择前端框架
  • 3月27日云栖精选夜读 | 从 “城市大脑”实践,瞭望未来城市源起 ...
  • #define,static,const,三种常量的区别
  • #define用法
  • (02)Hive SQL编译成MapReduce任务的过程
  • (10)Linux冯诺依曼结构操作系统的再次理解
  • (C语言)fread与fwrite详解
  • (Git) gitignore基础使用
  • (ZT)北大教授朱青生给学生的一封信:大学,更是一个科学的保证
  • (附源码)ssm旅游企业财务管理系统 毕业设计 102100
  • (十二)devops持续集成开发——jenkins的全局工具配置之sonar qube环境安装及配置
  • (转) RFS+AutoItLibrary测试web对话框
  • (转)iOS字体
  • (转)如何上传第三方jar包至Maven私服让maven项目可以使用第三方jar包
  • (转载)微软数据挖掘算法:Microsoft 时序算法(5)
  • ******之网络***——物理***
  • .bat文件调用java类的main方法
  • .NET 命令行参数包含应用程序路径吗?
  • [20171113]修改表结构删除列相关问题4.txt
  • [ASP]青辰网络考试管理系统NES X3.5
  • [AX]AX2012 SSRS报表Drill through action
  • [BT]BUUCTF刷题第8天(3.26)
  • [BZOJ] 2006: [NOI2010]超级钢琴