后台管理接口

后台管理接口是许多 Web 应用程序的核心部分，提供对数据和系统资源的控制和管理。通常，后台管理系统需要支持用户管理、权限控制、日志记录等功能。本文将介绍如何构建一个简易的后台管理 API，使用 Koa 框架实现用户管理、权限控制和日志记录等常见功能。

1. 项目初始化与依赖安装

首先，初始化一个新的 Koa 项目，并安装必需的依赖：

mkdir koa-admin-api
cd koa-admin-api
npm init -y
npm install koa koa-router koa-bodyparser koa-logger jsonwebtoken bcryptjs

2. 基本服务器设置

创建一个 index.js 文件来启动我们的 Koa 应用并设置基本的路由。

const Koa = require('koa');
const Router = require('koa-router');
const bodyParser = require('koa-bodyparser');
const logger = require('koa-logger');

const app = new Koa();
const router = new Router();

app.use(logger());
app.use(bodyParser());

router.get('/', async (ctx) => {
  ctx.body = 'Admin API Service is running';
});

app.use(router.routes()).use(router.allowedMethods());

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

3. 用户管理

后台管理系统通常需要提供用户管理功能，包括注册、登录、更新和删除用户。

3.1 用户注册

用户注册接口接收用户名、密码等信息，并将用户信息存储到数据库。

const bcrypt = require('bcryptjs');

router.post('/register', async (ctx) => {
  const { username, password } = ctx.request.body;
  if (!username || !password) {
    ctx.status = 400;
    ctx.body = { message: 'Username and password are required' };
    return;
  }

  const hashedPassword = await bcrypt.hash(password, 10);
  const user = { username, password: hashedPassword };

  // 假设保存到数据库
  // db.save(user);

  ctx.body = { message: 'User registered successfully' };
});

3.2 用户登录

用户登录接口验证用户名和密码，生成 JWT token 作为用户认证凭证。

const jwt = require('jsonwebtoken');

router.post('/login', async (ctx) => {
  const { username, password } = ctx.request.body;

  // 假设从数据库获取用户
  const user = { username: 'admin', password: '$2a$10$...hashedPassword...' };  // 这里是数据库获取的示例

  const isPasswordValid = await bcrypt.compare(password, user.password);
  if (!isPasswordValid) {
    ctx.status = 401;
    ctx.body = { message: 'Invalid credentials' };
    return;
  }

  const token = jwt.sign({ username: user.username }, 'your-secret-key', { expiresIn: '1h' });
  ctx.body = { message: 'Login successful', token };
});

4. 权限控制

后台管理系统通常需要实现权限控制，确保只有具有相应角色或权限的用户可以访问某些接口。

4.1 验证 JWT token

通过中间件验证用户的 JWT token。

router.use(async (ctx, next) => {
  const token = ctx.headers['authorization'];
  if (!token) {
    ctx.status = 401;
    ctx.body = { message: 'No token provided' };
    return;
  }

  try {
    const decoded = jwt.verify(token, 'your-secret-key');
    ctx.state.user = decoded;
    await next();
  } catch (err) {
    ctx.status = 401;
    ctx.body = { message: 'Invalid or expired token' };
  }
});

4.2 权限检查

根据用户的角色或权限控制 API 访问。

router.get('/admin-dashboard', async (ctx) => {
  if (ctx.state.user.role !== 'admin') {
    ctx.status = 403;
    ctx.body = { message: 'Forbidden' };
    return;
  }
  ctx.body = { message: 'Welcome to the Admin Dashboard' };
});

5. 日志记录

日志记录是后台管理系统的一个重要功能，通常用于记录 API 调用、错误信息等。

5.1 请求日志

使用 koa-logger 记录所有请求的日志。

app.use(logger());

5.2 错误日志

使用中间件捕获未处理的错误，并记录日志。

app.use(async (ctx, next) => {
  try {
    await next();
  } catch (err) {
    console.error('Error:', err);
    ctx.status = 500;
    ctx.body = { message: 'Internal Server Error' };
  }
});

6. 数据存储

后台管理系统需要持久化数据。可以选择使用数据库来存储用户信息、日志、配置等数据。

6.1 示例：MongoDB 数据存储

const mongoose = require('mongoose');
mongoose.connect('mongodb://localhost/admin-api', { useNewUrlParser: true, useUnifiedTopology: true });

const userSchema = new mongoose.Schema({
  username: { type: String, required: true },
  password: { type: String, required: true },
});

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

7. 总结

通过上述步骤，我们可以构建一个简单的后台管理 API 服务，包含用户管理、权限控制和日志记录等功能。Koa 提供了灵活的中间件机制，能够帮助我们快速搭建和扩展后台 API 服务。根据实际需求，您还可以进一步扩展功能，如多角色权限管理、API 文档生成等。

该后台管理 API 可以作为一个基础框架，支持更多高级功能的实现。