api 源码

API 源码解析与实现

项目结构

核心功能模块

路由定义 (routes/api.js)

const express = require('express');
const router = express.Router();
const userController = require('../controllers/user');
// 用户相关路由
router.post('/users', userController.createUser); // 创建用户
router.get('/users/:id', userController.getUserById); // 查询用户
router.put('/users/:id', userController.updateUser); // 更新用户
router.delete('/users/:id', userController.deleteUser); // 删除用户
module.exports = router;

控制器逻辑 (controllers/user.js)

const User = require('../models/user');
// 创建用户
exports.createUser = async (req, res) => {
  try {
    const { name, email } = req.body;
    const newUser = new User({ name, email });
    await newUser.save();
    res.status(201).json(newUser);
  } catch (error) {
    res.status(400).json({ error: error.message });
  }
};
// 查询用户
exports.getUserById = async (req, res) => {
  try {
    const user = await User.findById(req.params.id);
    if (!user) return res.status(404).json({ error: 'User not found' });
    res.json(user);
  } catch (error) {
    res.status(500).json({ error: error.message });
  }
};

数据模型 (models/user.js)

const mongoose = require('mongoose');
const userSchema = new mongoose.Schema({
  name: { type: String, required: true },
  email: { type: String, required: true, unique: true },
  createdAt: { type: Date, default: Date.now },
});
module.exports = mongoose.model('User', userSchema);

关键技术点

中间件集成

数据库连接 (config/db.js)

const mongoose = require('mongoose');
const connectDB = async () => {
  try {
    await mongoose.connect(process.env.MONGO_URI, { useNewUrlParser: true, useUnifiedTopology: true });
    console.log('MongoDB connected');
  } catch (error) {
    console.error('Database connection failed:', error.message);
    process.exit(1);
  }
};
module.exports = connectDB;

相关问题与解答

问题1：如何扩展API以支持用户角色管理？

解答：

1. 修改数据模型：在 models/user.js 中添加 role 字段

   role: { type: String, enum: ['user', 'admin'], default: 'user' }

2. 更新路由：在 routes/api.js 中添加角色相关接口

   router.patch('/users/:id/role', userController.updateUserRole);

3. 实现逻辑：在 controllers/user.js 中添加角色更新函数

   exports.updateUserRole = async (req, res) => {
     try {
       const { role } = req.body;
       const user = await User.findByIdAndUpdate(req.params.id, { role }, { new: true });
       res.json(user);
     } catch (error) {
       res.status(400).json({ error: error.message });
     }
   };

问题2：如何处理数据库连接超时错误？

解答：

1. 配置重试机制：在 config/db.js 中添加重试逻辑

   const connectWithRetry = async (attempt = 1) => {
     try {
       await mongoose.connect(process.env.MONGO_URI, { useNewUrlParser: true, useUnifiedTopology: true });
       console.log('MongoDB connected');
     } catch (error) {
       if (attempt < 5) {
         console.warn(`Retrying connection (${attempt + 1})...`);
         setTimeout(() => connectWithRetry(attempt + 1), 2000);
       } else {
         console.error('Database connection failed:', error.message);
         process.exit(1);
       }
     }
   };

2. 优化错误提示：在控制器中区分网络错误与业务错误

   if (error.name === 'MongoNetworkError') {
     res.status(503).json({ error: 'Database service unavailable' });
   } else {
     res.status(500).json({ error: error.message });

小伙伴们，上文介绍了“api 源码”的内容，你了解清楚吗？希望对你有所帮助，任何问题可以给我留言，让我们下期再见吧。