使用 Express 和 waterline 創建簡單 Restful API

来源:http://www.cnblogs.com/9527/archive/2016/12/08/6144615.html
-Advertisement-
Play Games

這幾篇都是我原來首發在 segmentfault 上的地址：https://segmentfault.com/a/1190000004996659 突然想起來我這個博客冷落了好多年了，也該更新一下，呵呵 最近想重寫一下網站的Restful API，原來是用PHP寫的，看到現在nodejs這麼火也想試 ...


這幾篇都是我原來首發在 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'});
        });
    });

總結

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


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • javascript的垃圾收集機制
    [1]原理 [2]標記清除 [3]引用計數 [4]性能問題 [5]記憶體管理 ...
  • 微小，但是美好的改變 G2 2.2發佈
    G2 2.2.0, 『微小，但是美好的改變。』 # 一、豐富可視化交互形式 #### 選擇: [圖形的單選、多選](https://g2.alipay.com/tutorial/geom-select.html)以及[框選](https://g2.alipay.com/tutorial/ranges ...
  • JS高程3.基本概念（3）
    1.ECMAScript數值的範圍 由於記憶體的限制，在大多數瀏覽器中，ECMAScript能夠拿保存的數據的範圍是 5e-324 ~ 1.7976931348623157e+308，其中最小的數值保存在Number.MIN_VALUE中，最大的數值保存在Number.MAX_VALUE中。 如果在計 ...
  • 分享12306搶票心得-終極秒殺思路篇
    12306搶票的關鍵拼的就是整點出票的速度，快的幾秒鐘，慢的幾分鐘，本文提供終極搶票攻略，通過多線程掃描上萬個CDN，來大幅度提升出票速度，最終快人一步搶到票 ...
  • angular-JS模仿Form表單提交
    直接上示例代碼，有不懂的歡迎留言： ...
  • 相容當前多瀏覽器的漸變顏色背景gradient的寫法
    相容多瀏覽器就要為每一個瀏覽器寫對應的CSS，太低版本的瀏覽器只能使用圖片做背景。本文結合例子，介紹了當前五大瀏覽器對gradient的支持情況。 ...
  • JS實現頁面進入、返回定位到具體位置
    最為一個剛入職不久的小白。。。慢慢磨練吧。。。 JS實現頁面返回定位到具體位置 其實瀏覽器也自帶了返回的功能，也就是說，自帶了返回定位的功能。正常的跳轉，返回確實可以定位，但是有些特殊場景就不適用了。例如，某些元素是在某種情況下才加上的，又或者多級定位。 目前，我知道的返回定位到具體位置有兩種方法： ...
  • 倒計時小實例（多次定時）
    一個簡單的js計時函數（多次定時） ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類