使用 Express 和 waterline 创建简单 Restful API

本文涉及的产品
云数据库 RDS MySQL,集群系列 2核4GB
推荐场景:
搭建个人博客
RDS MySQL Serverless 基础系列,0.5-2RCU 50GB
RDS MySQL Serverless 高可用系列,价值2615元额度,1个月
简介:

这几篇都是我原来首发在 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'}); }); }); 

总结

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





    本文转自无心之柳.NET博客园博客,原文链接:http://www.cnblogs.com/9527/p/6144615.html,如需转载请自行联系原作者



相关实践学习
如何在云端创建MySQL数据库
开始实验后,系统会自动创建一台自建MySQL的 源数据库 ECS 实例和一台 目标数据库 RDS。
全面了解阿里云能为你做什么
阿里云在全球各地部署高效节能的绿色数据中心,利用清洁计算为万物互联的新世界提供源源不断的能源动力,目前开服的区域包括中国(华北、华东、华南、香港)、新加坡、美国(美东、美西)、欧洲、中东、澳大利亚、日本。目前阿里云的产品涵盖弹性计算、数据库、存储与CDN、分析与搜索、云通信、网络、管理与监控、应用服务、互联网中间件、移动服务、视频服务等。通过本课程,来了解阿里云能够为你的业务带来哪些帮助     相关的阿里云产品:云服务器ECS 云服务器 ECS(Elastic Compute Service)是一种弹性可伸缩的计算服务,助您降低 IT 成本,提升运维效率,使您更专注于核心业务创新。产品详情: https://www.aliyun.com/product/ecs
相关文章
|
9天前
|
JSON JavaScript 前端开发
深入浅出Node.js:从零开始构建RESTful API
在数字化时代的浪潮中,后端开发作为连接用户与数据的桥梁,扮演着至关重要的角色。本文将引导您步入Node.js的奇妙世界,通过实践操作,掌握如何使用这一强大的JavaScript运行时环境构建高效、可扩展的RESTful API。我们将一同探索Express框架的使用,学习如何设计API端点,处理数据请求,并实现身份验证机制,最终部署我们的成果到云服务器上。无论您是初学者还是有一定基础的开发者,这篇文章都将为您打开一扇通往后端开发深层知识的大门。
26 12
|
12天前
|
XML JSON 缓存
深入理解RESTful API设计原则与实践
在现代软件开发中,构建高效、可扩展的应用程序接口(API)是至关重要的。本文旨在探讨RESTful API的核心设计理念,包括其基于HTTP协议的特性,以及如何在实际应用中遵循这些原则来优化API设计。我们将通过具体示例和最佳实践,展示如何创建易于理解、维护且性能优良的RESTful服务,从而提升前后端分离架构下的开发效率和用户体验。
|
15天前
|
监控 安全 API
深入浅出:构建高效RESTful API的最佳实践
在数字化时代,API已成为连接不同软件和服务的桥梁。本文将带你深入了解如何设计和维护一个高效、可扩展且安全的RESTful API。我们将从基础概念出发,逐步深入到高级技巧,让你能够掌握创建优质API的关键要素。无论你是初学者还是有经验的开发者,这篇文章都将为你提供实用的指导和启示。让我们一起探索API设计的奥秘,打造出色的后端服务吧!
|
13天前
|
JSON 缓存 测试技术
构建高效RESTful API的后端实践指南####
本文将深入探讨如何设计并实现一个高效、可扩展且易于维护的RESTful API。不同于传统的摘要概述,本节将直接以行动指南的形式,列出构建RESTful API时必须遵循的核心原则与最佳实践,旨在为开发者提供一套直接可行的实施框架,快速提升API设计与开发能力。 ####
|
14天前
|
JSON API 开发者
深入理解RESTful API设计原则
在数字化时代,API已成为连接不同软件应用的桥梁。本文旨在探讨RESTful API设计的基本原则和最佳实践,帮助开发者构建高效、可扩展的网络服务接口。通过解析REST架构风格的核心概念,我们将了解如何设计易于理解和使用的API,同时保证其性能和安全性。
|
14天前
|
存储 缓存 API
深入理解RESTful API设计原则
在现代软件开发中,RESTful API已成为前后端分离架构下不可或缺的通信桥梁。本文旨在探讨RESTful API的核心设计原则,包括资源导向、无状态、统一接口、以及可缓存性等,并通过实例解析如何在实际应用中遵循这些原则来构建高效、可维护的API接口。我们将深入分析每个原则背后的设计理念,提供最佳实践指导,帮助开发者优化API设计,提升系统整体性能和用户体验。
16 0
|
14天前
|
安全 测试技术 API
构建高效RESTful API:后端开发的艺术与实践####
在现代软件开发的浩瀚星空中,RESTful API如同一座桥梁,连接着前端世界的绚丽多彩与后端逻辑的深邃复杂。本文旨在探讨如何精心打造一款既高效又易于维护的RESTful API,通过深入浅出的方式,剖析其设计原则、实现技巧及最佳实践,为后端开发者提供一份实用的指南。我们不深入晦涩的理论,只聚焦于那些能够即刻提升API品质与开发效率的关键点,让你的API在众多服务中脱颖而出。 ####
24 0
|
安全 中间件 API
如何创建一个安全的API(一)
本文讲的是如何创建一个安全的API(一),毫无疑问,我们生活的世界正在随着时间的前行联系越来越紧密。无数新服务的出现都在帮助我们去使生活变得更简单,更愉快,而在这些所有变化的背后,服务们在进行组合交流所使用的是一项技术—API驱动架构。
1443 0
|
9天前
|
JSON API 开发工具
淘宝实时 API 接口丨淘宝商品详情接口(Taobao.item_get)
淘宝商品详情接口(Taobao.item_get)允许开发者获取商品的详细信息,包括基本信息、描述、卖家资料、图片、属性及销售情况等。开发者需注册账号、创建应用并获取API密钥,通过构建请求获取JSON格式数据,注意遵守平台规则,合理使用接口,确保数据准确性和时效性。
|
10天前
|
JSON 安全 API
Python调用API接口的方法
Python调用API接口的方法
50 5