30分钟用Node.js构建一个API服务器

时间  2019-11-05 标签 30分 钟 node.js node js 构建 一个 api 服务器
翻译：疯狂的技术宅
原文： https://medium.freecodecamp.o...

本文首发微信公众号：前端先锋
欢迎关注，天天都给你推送新鲜的前端技术文章javascript

Node.js 对初学者来讲多是使人望而却步的，其灵活的结构和缺少严格的规范使它看起来很复杂。前端

本教程是 Node.js，Express 框架和 MongoDB 的快速指南，重点介绍基本的 REST 路由和基本的数据库交互。你将构建一个简单的 API 框架模版，而后能够将其用做任何应用。java

本教程适用于：你应该对 REST API 和 CRUD 操做有基本的了解，还有基本的 JavaScript 知识。我用的是 ES6（主要是箭头函数），但并非很复杂。node

在本教程中，咱们将为建立一个网络笔记应用的后端骨架 —— 相似于Google Keep，可以执行全部的四个CRUD操做：建立、读取、更新和删除。git

配置

若是你没有安装Node，请参阅此处。程序员

建立一个新目录，运行 npm init，而后按照提示操做，把你的应用程序命名为“notable”（或者你可能喜欢的其余名字）。github

npm init

一旦完成，在你的目录中会有一个 package.json 文件。你能够开始安装项目所需的依赖项了。面试

咱们将使用 Express 做为本身的框架，MongoDB 做为数据库，还有一个名为 body-parser 的包来帮助处理 JSON 请求。mongodb

npm install --save express mongodb@2.2.16 body-parser

我还强烈建议将 Nodemon 安装为 dev 依赖项。这是一个很是简单的小包，可在文件被更改时自动重启服务器。数据库

若是你运行：

npm install --save-dev nodemon

而后将如下脚本添加到 package.json：

// package.json
  "scripts": {
    "dev": "nodemon server.js"
  },

完整的 package.json 应以下所示：

// package.json
{
  "name": "notable",
  "version": "1.0.0",
  "description": "",
  "main": "server.js",
  "scripts": {
    "dev": "nodemon server.js"
  },
  "author": "",
  "license": "ISC",
  "dependencies": {
    "body-parser": "^1.15.2",
    "express": "^4.14.0",
    "mongodb": "^2.2.16"
  },
  "devDependencies": {
    "nodemon": "^1.11.0"
  }
}

如今，你能够建立 server.js 文件并构建 API 了。

咱们的服务器

首先导入 server.js 中的全部依赖项。

// server.js
const express        = require('express');
const MongoClient    = require('mongodb').MongoClient;
const bodyParser     = require('body-parser');
const app            = express();

咱们将使用 MongoClient 与数据库进行交互。还会将应用初始化为 Express 框架的实例。

最后一件事就是告诉你的程序开始监听请求。

你能够指定一个端口，并像这样开始监听：

// server.js
const port = 8000;
app.listen(port, () => {
  console.log('We are live on ' + port);
});

如今，若是你运行 npm run dev（或 node server.js，若是你没有安装 Nodemon 的话），应该在终端中看到“We are live on port 8000”的提示。

你的服务器已经启动了。但它如今还什么也作不了。

接下来让咱们解决这个问题。

CRUD 路由

对于本例，你要构建4条路由; 建立笔记，阅读笔记，更新笔记和删除笔记。

这将使你了解如何使用 Node 构建几乎全部的基本路由。

可是，要测试你的API，还须要模仿客户端发出请求。为此，咱们将使用名为 Postman 的优秀应用。它容许你使用自定义的头和参数进行简单的 HTTP 请求。

安装Postman，让咱们开始设置路由。

项目结构

大多数 Node.js 教程（以及许多真实的案例）都将全部路由放在一个很大的 routes.js 文件中。这让我有点不舒服。相比之下，将文件拆到为单独的文件夹能够提升可读性，并使大型应用更易于管理。

虽然咱们如今作的不是大型应用，但仍然能够这样作。建立如下目录：一个 app 文件夹，里面有一个routes文件夹，routes 里面有 index.js 和 note_routes.js 文件。

mkdir app
cd app
mkdir routes
cd routes
touch index.js
touch note_routes.js

对于你的简单小程序来讲，这些目录可能看起来有些过度，但从一开始就作好老是有意义的。

你的第一个路由

让咱们从 CRUD 中的 C 开始。你将会如何建立一个笔记？

那么，在你开始以前，必须先要打好基础。在Express中，路由包含在一个函数中，该函数将 Express 实例和数据库做为参数。

像这样：

// routes/note_routes.js
module.exports = function(app, db) {
};

而后，你能够经过 index.js 导出此函数：

// routes/index.js
const noteRoutes = require('./note_routes');
module.exports = function(app, db) {
  noteRoutes(app, db);
  // Other route groups could go here, in the future
};

而后导入它以便在 server.js 中使用：

// server.js
const express        = require('express');
const MongoClient    = require('mongodb').MongoClient;
const bodyParser     = require('body-parser');
const app            = express();
const port = 8000;
require('./app/routes')(app, {});
app.listen(port, () => {
  console.log('We are live on ' + port);
});

请注意，因为尚未设置数据库，所以只需传入一个空对象。

好的，如今你能够制做本身的 CREATE 路由了。

语法很简单：

// note_routes.js
module.exports = function(app, db) {
  app.post('/notes', (req, res) => {
    // You'll create your note here.
    res.send('Hello')
  });
};

当应用程序收到对 '/ notes' 路径的 post 请求时，它将执行回调内的代码 —— request 对象（包含请求的参数或JSON）和 response 对象。

你可使用 Postman 将 POST 请求发送到 localhost:8000/notes 来测试。

clipboard.png

你应该获得回复：'Hello'。

太好了！你建立了第一个真正的路由。

下一步是在你的请求中添加一些参数并在 API 中处理它们，最后添加到你的数据库中。

请求参数

在 Postman 中，在选择 x-www-form-urlencoded 单选按钮后，转到 Body 选项卡并添加一些键值对。

这会将编码后的表单数据添加到你的请求中，你可使用 API ​​处理该请求。

clipboard.png

你能够去尝试更多的设置项。

如今在你的 note_routes.js 中，让咱们输出 body 的内容。

// note_routes.js
module.exports = function(app, db) {
  app.post('/notes', (req, res) => {
    console.log(req.body)
    res.send('Hello')
  });
};

用 Postman 发送请求，你会看到……undefined。

不幸的是，Express 没法自行处理 URL 编码的表单。虽然你确实安装了这个 body-parser 包......

// server.
const express        = require('express');
const MongoClient    = require('mongodb').MongoClient;
const bodyParser     = require('body-parser');
const app            = express();
const port = 8000;
app.use(bodyParser.urlencoded({ extended: true }));
require('./app/routes')(app, {});
app.listen(port, () => {
  console.log('We are live on ' + port);
});

Now you should see the body as an object in the terminal.
如今你应该将 body 视为终端中的对象。

{ title: 'My Note Title', body: 'What a great note.' }

第一个路由的最后一步：设置数据库，而后添加数据。

最简单方法是经过 mLab 设置 Mongo 数据库的：它是最小的并且是免费的，设置的速度很是快。

建立账户和 MongoDB 部署后，将用户的用户名和密码添加到数据库：

clipboard.png

而后复制这里第二个 URL：

clipboard.png

在项目根目录的目录配置中，建立一个db.js文件。

mkdir config 
cd config
touch db.js

在里面，添加刚才的URL：

module.exports = {
  url : YOUR URL HERE
};

别忘了把你的用户名和密码（来自数据库用户的密码，而不是你的 mLab 账户）添加到URL中。 （若是你要将此项目提交到 Github 上，请确保包含 .gitignore 文件 像这样, ，不要与任何人分享你的密码。）

如今在你的 server.js 中，能够用 MongoClient 链接到数据库了，使用它来包装你的应用程序设置：

// server.js
const express        = require('express');
const MongoClient    = require('mongodb').MongoClient;
const bodyParser     = require('body-parser');
const db             = require('./config/db');
const app            = express();
const port = 8000;
app.use(bodyParser.urlencoded({ extended: true }));
MongoClient.connect(db.url, (err, database) => {
  if (err) return console.log(err)
  require('./app/routes')(app, database);
  app.listen(port, () => {
    console.log('We are live on ' + port);
  });               
})

若是你用的是最新版本的 MongoDB（3.0+），请将其修改成：

// server.js
const express        = require('express');
const MongoClient    = require('mongodb').MongoClient;
const bodyParser     = require('body-parser');
const db             = require('./config/db');
const app            = express();
const port = 8000;
app.use(bodyParser.urlencoded({ extended: true }));
MongoClient.connect(db.url, (err, database) => {
  if (err) return console.log(err)
                      
  // Make sure you add the database name and not the collection name
  const database = database.db("note-api")
  require('./app/routes')(app, database);
  app.listen(port, () => {
    console.log('We are live on ' + port);
  });               
})

这是你的基础架构的最后一个设置！

添加到你的数据库

MongoDB将数据存储在 collections 中。在你的项目中，你但愿将笔记存储在一个名为 notes 的 collection 中。

因为将数据库做为路径中的 db 参数传入，所以能够像这样访问它：

db.collection('notes')

建立笔记就像在集合上调用 insert 同样简单：

const note = { text: req.body.body, title: req.body.title}
  db.collection('notes').insert(note, (err, results) => {
}

插入完成后（或因为某种缘由失败），要么返回错误或反回新建立的笔记对象。这是完整的 note_routes.js 代码：

// note_routes.js
module.exports = function(app, db) {
  const collection = 
  app.post('/notes', (req, res) => {
    const note = { text: req.body.body, title: req.body.title };
    db.collection('notes').insert(note, (err, result) => {
      if (err) { 
        res.send({ 'error': 'An error has occurred' }); 
      } else {
        res.send(result.ops[0]);
      }
    });
  });
};

试试看！使用 Postman 发送 x-www-form-urlencoded POST 请求，在 Body 选项卡下设置 title 和 body。

响应应以下所示：

clipboard.png

若是你登陆mLab，你还应该可以在数据库中看到建立的笔记。

READ 路由

如今能够稍微加快步伐。

假设你但愿经过导航到 localhost:8000/notes/{id} 来获取刚建立的笔记。这是连接应该是localhost:8000/notes/585182bd42ac5b07a9755ea3。（若是你没有获得其中笔记的 ID，能够经过检查 mLab 或建立一个新的笔记）。

如下是 note_routes.js 中的内容：

// note_routes.js
module.exports = function(app, db) {
  app.get('/notes/:id', (req, res) => {
    
  });
  app.post('/notes', (req, res) => {
    const note = { text: req.body.body, title: req.body.title };
    db.collection('notes').insert(note, (err, result) => {
      if (err) { 
        res.send({ 'error': 'An error has occurred' }); 
      } else {
        res.send(result.ops[0]);
      }
    });
  });
};

就像之前同样，你将在数据库 collection 中调用一个方法。在这里，它被恰当地命名为 findOne。

// note_routes.js
module.exports = function(app, db) {
  app.get('/notes/:id', (req, res) => {
    const details = { '_id': <ID GOES HERE> };
    db.collection('notes').findOne(details, (err, item) => {
      if (err) {
        res.send({'error':'An error has occurred'});
      } else {
        res.send(item);
      }
    });
  });
app.post('/notes', (req, res) => {
    const note = { text: req.body.body, title: req.body.title };
    db.collection('notes').insert(note, (err, result) => {
      if (err) { 
        res.send({ 'error': 'An error has occurred' }); 
      } else {
        res.send(result.ops[0]);
      }
    });
  });
};

你能够经过 req.params.id 从 URL 参数中获取 id。可是，若是你试图将字符串插入上面的 <ID GOES HERE> 位置，它将没法正常工做。

MongoDB 不只要求 ID 为字符串，还要求 ID 是一个对象，它们被之为 ObjectID。

别担忧，这很容易解决。这是完整的代码：

// note_routes.js
var ObjectID = require('mongodb').ObjectID;
module.exports = function(app, db) {
  app.get('/notes/:id', (req, res) => {
    const id = req.params.id;
    const details = { '_id': new ObjectID(id) };
    db.collection('notes').findOne(details, (err, item) => {
      if (err) {
        res.send({'error':'An error has occurred'});
      } else {
        res.send(item);
      } 
    });
  });
app.post('/notes', (req, res) => {
    const note = { text: req.body.body, title: req.body.title };
    db.collection('notes').insert(note, (err, result) => {
      if (err) { 
        res.send({ 'error': 'An error has occurred' }); 
      } else {
        res.send(result.ops[0]);
      }
    });
  });
};

尝试使用一个笔记 ID，它应以下所示：

clipboard.png

DELETE 路由

实际上删除对象与查找对象几乎相同。你只需用 remove 函数替换 findOne 便可。这是完整的代码：

// note_routes.js
// ...
  app.delete('/notes/:id', (req, res) => {
    const id = req.params.id;
    const details = { '_id': new ObjectID(id) };
    db.collection('notes').remove(details, (err, item) => {
      if (err) {
        res.send({'error':'An error has occurred'});
      } else {
        res.send('Note ' + id + ' deleted!');
      } 
    });
  });
// ...

UPDATE 路由

最后一个！ PUT 方法基本上是 READ 和 CREATE 的混合体。你找到该对象，而后更新它。若是刚才你删除了数据库中惟一的笔记，那就再建立一个！

代码：

// note_routes.js
// ...
  app.put('/notes/:id', (req, res) => {
    const id = req.params.id;
    const details = { '_id': new ObjectID(id) };
    const note = { text: req.body.body, title: req.body.title };
    db.collection('notes').update(details, note, (err, result) => {
      if (err) {
          res.send({'error':'An error has occurred'});
      } else {
          res.send(note);
      } 
    });
  });
// ...

如今你能够更新任何笔记，以下所示：

clipboard.png

请注意这些代码还不完美 —— 好比你没有提供正文或标题，PUT 请求将会使数据库中的笔记上的那些字段无效。

API 完成

就这么简单！你完成了能够进行 CRUD 操做的 Node API。

本教程的目的是让你熟悉 Express、Node 和 MongoDB —— 你能够用简单的程序做为进军更复杂项目的跳板。

未来我将会编写系列教程，用不一样的语言和框架建立更简单的API。若是你有兴趣，请点击关注！

本文首发微信公众号：前端先锋

欢迎扫描二维码关注公众号，天天都给你推送新鲜的前端技术文章

欢迎扫描二维码关注公众号，天天都给你推送新鲜的前端技术文章

欢迎继续阅读本专栏其它高赞文章：

联系我们 沪ICP备2021010478号-7