使用 Node.js 构建一个简单的 RESTful API

使用 Node.js 构建一个简单的 RESTful API

Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境，它可以让开发者使用 JavaScript 来编写服务器端的应用程序。RESTful API 是一种构建网络服务的标准方法，它遵循特定的原则来组织网络应用的行为。在这篇文章中，我们将使用 Node.js 和 Express 框架来创建一个简单的 RESTful API，该 API 将处理一组假想的商品数据。

1. 环境准备

首先，确保你的开发环境中已经安装了 Node.js。接下来，我们需要安装 Express 框架和其他必要的依赖包。

打开终端或命令提示符，执行以下命令来初始化一个新的 Node.js 项目：

mkdir product-api
cd product-api
npm init -y

然后安装 Express 和其他必要的库：

npm install express body-parser cors

2. 创建基础结构

创建一个名为 server.js 的文件，这将是我们的主应用程序入口点。

server.js 文件内容：

const express = require('express');
const bodyParser = require('body-parser');
const cors = require('cors');

const app = express();

// Middleware
app.use(bodyParser.json());
app.use(cors());

// Mock Data
let products = [
  {
    id: 1, name: 'Laptop', price: 1000 },
  {
    id: 2, name: 'Smartphone', price: 500 },
  {
    id: 3, name: 'Headphones', price: 150 },
];

// Routes
app.get('/api/products', (req, res) => {
   
  res.json(products);
});

app.get('/api/products/:id', (req, res) => {
   
  const product = products.find(p => p.id === parseInt(req.params.id));
  if (!product) return res.status(404).send('Product not found.');
  res.json(product);
});

app.post('/api/products', (req, res) => {
   
  const product = {
   
    id: Date.now(),
    name: req.body.name,
    price: req.body.price,
  };
  products.push(product);
  res.status(201).json(product);
});

app.put('/api/products/:id', (req, res) => {
   
  const product = products.find(p => p.id === parseInt(req.params.id));
  if (!product) return res.status(404).send('Product not found.');

  product.name = req.body.name || product.name;
  product.price = req.body.price || product.price;

  res.json(product);
});

app.delete('/api/products/:id', (req, res) => {
   
  const productIndex = products.findIndex(p => p.id === parseInt(req.params.id));
  if (productIndex === -1) return res.status(404).send('Product not found.');

  const deletedProduct = products.splice(productIndex, 1);
  res.json(deletedProduct[0]);
});

// Start the server
const port = process.env.PORT || 3000;
app.listen(port, () => console.log(`Listening on port ${
     port}...`));

3. 测试 API

为了测试我们的 API，我们可以使用 Postman 或类似的 HTTP 请求工具，或者直接使用 curl 命令。这里我们简单展示如何使用 curl 来测试 GET 请求：

curl http://localhost:3000/api/products

这将返回所有的商品列表。同样，你可以测试其他 HTTP 方法，如 POST、PUT 和 DELETE。

4. 运行应用

最后，启动我们的 Node.js 应用：

node server.js

访问 http://localhost:3000/api/products，你应该能看到 JSON 格式的商品列表。

这个示例展示了如何使用 Node.js 和 Express 框架来创建一个简单的 RESTful API。通过实践这样的项目，你不仅能够熟悉 Node.js 的基本用法，还能学会如何处理 HTTP 请求和响应，以及如何管理数据。