零基础之Node.js搭建API服务器的详解

下面是“零基础之Node.js搭建API服务器的详解”的完整攻略：

介绍

本文主要讲解如何使用Node.js搭建一个简单的API服务器，使用的工具有Express和MongoDB，主要内容包括：

• 安装Node.js和MongoDB
• 使用Express快速生成项目框架
• 定义API接口
• 连接数据库
• 编写API接口的实现
• 测试API接口

步骤

1. 安装Node.js和MongoDB

首先需要安装Node.js和MongoDB，这里不再赘述，安装方法可以参考其官方文档。

2. 使用Express快速生成项目框架

使用Express可以快速生成项目框架，具体步骤如下：

1. 安装Express：

bash
npm install express --save

1. 创建项目文件夹，并在其中初始化npm：

bash
mkdir api-server
cd api-server
npm init

初始化npm后需要填写一些项目信息。

1. 使用Express生成项目框架：

bash
npx express-generator

生成的项目框架包含了一些常用的工具和配置文件。

1. 安装依赖：

bash
npm install

安装依赖后，就可以启动服务器了：

bash
npm start

打开浏览器，访问http://localhost:3000，应该就能看到欢迎界面了。

3. 定义API接口

在routes文件夹下新建一个文件api.js，定义API接口，示例代码：

var express = require('express');
var router = express.Router();

// 定义获取用户信息的API
router.get('/user/:id', function(req, res, next) {
  const userId = req.params.id;
  // TODO: 实现获取用户信息的逻辑
  res.send(`获取用户信息，用户ID为${userId}`);
});

module.exports = router;

4. 连接数据库

接下来需要连接MongoDB数据库，可以使用mongoose库来连接和操作MongoDB数据库，具体步骤如下：

1. 安装mongoose库：

bash
npm install mongoose --save

1. 在app.js中添加代码连接数据库，示例代码：

const mongoose = require('mongoose');

mongoose.connect('mongodb://localhost/api-server', { useNewUrlParser: true });
const db = mongoose.connection;
db.on('error', console.error.bind(console, 'connection error:'));
db.once('open', function() {
  console.log('MongoDB connected!');
});

5. 编写API接口的实现

在之前定义API接口的基础上，需要编写API接口的具体实现，示例代码：

const User = require('../models/user');

// 定义获取用户信息的API
router.get('/user/:id', function(req, res, next) {
  const userId = req.params.id;
  User.findById(userId, function(err, user) {
    if (err) return next(err);
    res.json(user);
  });
});

需要注意的是，在上述代码中使用了User这个model，需要在models文件夹下新建一个文件user.js，定义User这个model，示例代码：

const mongoose = require('mongoose');

const userSchema = mongoose.Schema({
  name: String,
  age: Number,
  email: String
});

const User = mongoose.model('User', userSchema);

module.exports = User;

6. 测试API接口

最后需要测试一下API接口是否能正常工作，示例如下：

启动服务器：

npm start

使用curl命令测试API：

curl http://localhost:3000/api/user/1

如果返回了预期的结果，就说明API接口已经正常工作了。

示例说明

下面给出几个示例说明：

示例1：定义获取文章信息的API

定义获取文章信息的API，需要在routes/api.js中添加如下代码：

const Article = require('../models/article');

// 定义获取文章信息的API
router.get('/article/:id', function(req, res, next) {
  const articleId = req.params.id;
  Article.findById(articleId, function(err, article) {
    if (err) return next(err);
    res.json(article);
  });
});

需要注意的是这里使用了Article这个model，需要在models文件夹下新建一个文件article.js，定义Article这个model，示例代码：

const mongoose = require('mongoose');

const articleSchema = mongoose.Schema({
  title: String,
  content: String
});

const Article = mongoose.model('Article', articleSchema);

module.exports = Article;

示例2：定义创建文章的API

定义创建文章的API，需要在routes/api.js中添加如下代码：

const Article = require('../models/article');

// 定义创建文章的API
router.post('/article', function(req, res, next) {
  const title = req.body.title;
  const content = req.body.content;
  const article = new Article({title, content});
  article.save(function(err, article) {
    if (err) return next(err);
    res.json(article);
  })
});

使用curl命令测试该API：

curl -X POST -d '{"title": "标题", "content": "内容"}' -H 'Content-Type: application/json' http://localhost:3000/api/article

如果返回了创建的文章信息，就说明API接口已经正常工作了。