使用Express构建RESTful API

RESTful服务

REST(Representational State Transfer)的意思是表征状态转移,它是一种基于HTTP协议的网络应用接口风格,充分利用HTTP的方法实现统一风格接口的服务。通过动词(HTTP方法)+名词(请求资源的接口路径)的方式请求资源,赋予接口特定的含义。

REST风格定义了一系列创建HTTP服务的惯例:

  • POST:创建资源
  • PUT:更新资源
  • GET:读取资源
  • DELETE:删除资源

例如:

  • 获取所有书籍: GET /api/books
  • 获取id为1的书籍: GET /api/books/1
  • 更新id为1的书籍:PUT /api/books/1
  • 删除id为1的书籍:DELETE /api/books/1
  • 添加书籍:POST /api/books

Express构建RESTful API

Express.js是一个轻量且灵活的Node.js WEB应用框架,可以快速搭建WEB应用。其底层是对Node.js的HTTP模块进行封装,增加路由、中间件等特性,使得用户能搭建应用级别的WEB服务。

处理GET请求

直接上代码:

const express = require('express');
const app = express();
const Joi = require('joi');

app.use(express.json());

const books = [
    { id: 1, name: 'book1'},
    { id: 2, name: 'book2'},
    { id: 3, name: 'book3'},
];

app.get('/', (req, res) => {
    res.end('Hello World!');
});
//获取所有书籍
app.get('/api/books', (req, res) => {
    res.json(books).end();
});
//获取特定id的书籍
app.get('/api/books/:id', (req, res) => {
    let book = books.find(b => b.id === parseInt(req.params.id));
    if(!book) return res.status(404).json({msg: 'The book with the given ID not find.'});
    res.json(book).end();
});

const port = process.env.PORT || 5000;
app.listen(port, () => console.log(`Listening on port ${port}`));

GET /api/books

image

GET /api/books/2

image

GET /api/books/5

image

处理POST请求

function validateBook(book){
    const schema = {
        name: Joi.string().min(3).required()
    };

    return Joi.validate(book, schema);
}

//使用POST方法添加书籍
app.post('/api/books', (req, res) => {
    const {error} = validateBook(req.body);
    if(error){
        return res.status(400).json({msg: error.details[0].message}).end();
    }

    const book = {
        id: books.length + 1,
        name: req.body.name
    };
    books.push(book);
    res.json(book).end();
});

POST /api/books

image

image

处理PUT请求

//使用PUT方法修改书籍
app.put('/api/books/:id', (req, res) => {
    let book = books.find(b => b.id === parseInt(req.params.id));
    if(!book) return res.status(404).json({msg: 'The book with the given ID not find.'});
    
    const { error } = validateBook(req.body);
    if(error) return res.status(400).json({msg: error.details[0].message}).end();

    book.name = req.body.name;
    res.json(book).end();
});

PUT /api/books/1

image

处理DELETE

//使用DELETE方法删除书籍
app.delete('/api/books/:id', (req, res) => {
    let book = books.find(b => b.id === parseInt(req.params.id));
    if(!book) return res.status(404).json({msg: 'The book with the given ID not find.'});

    const index = books.indexOf(book);
    books.splice(index, 1);

    res.json(book).end();
});

DELETE /api/books/1

image
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,099评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,828评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,540评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,848评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,971评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,132评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,193评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,934评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,376评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,687评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,846评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,537评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,175评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,887评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,134评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,674评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,741评论 2 351

推荐阅读更多精彩内容