TypeScript与Express：创建健壮的REST API

在构建现代Web应用程序时，选择合适的技术栈至关重要。TypeScript和Express作为JavaScript生态系统中的两颗明珠，它们的结合为开发高性能、易于维护的RESTful API提供了强大的支持。本文将详细介绍如何使用TypeScript和Express来创建一个健壮的REST API，包括设置开发环境、编写API路由、处理HTTP请求和响应，以及添加基本的安全措施。

1. 安装开发环境

首先，确保你的开发环境中安装了Node.js和npm（或yarn）。接下来，通过运行以下命令安装Express和TypeScript：

npm init -y
npm install express @types/express --save-dev

这将创建一个新的Node.js项目并安装Express框架及TypeScript相关类型定义。为了方便开发，可以进一步安装一些实用的开发工具包，如nodemon用于自动重启服务器：

npm install nodemon --save-dev

2. 创建基础API

接下来，创建一个简单的REST API。在项目根目录下创建一个名为server.ts的文件，并添加以下代码：

import express from 'express';

const app = express();
const port = 3000;

app.get('/', (req, res) => {
  res.send('Hello World!');
});

app.listen(port, () => {
  console.log(`Server running at http://localhost:${port}`);
});

通过上述代码，我们创建了一个简单的HTTP服务器，监听3000端口，并提供了一个默认的GET /路由，返回“Hello World!”。

3. 扩展API功能

3.1 添加用户认证

为了提高安全性，我们可以使用JWT（JSON Web Tokens）进行用户认证。首先，安装所需的依赖：

npm install jsonwebtoken --save

然后，在server.ts中引入并配置JWT：

import jwt from 'jsonwebtoken';
import { promisify } from 'util';

// 假设这是你的密钥
const secretKey = 'your-secret-key';

// 生成JWT
function generateToken(userId: string) {
  return jwt.sign({ userId }, secretKey, { expiresIn: '1h' });
}

// 验证JWT
async function verifyToken(req, res, next) {
  const authHeader = req.headers['authorization'];
  if (!authHeader) {
    return res.status(401).json({ message: '未提供认证信息' });
  }

  const token = authHeader.split(' ')[1];
  try {
    const decoded = await promisify(jwt.verify)(token, secretKey);
    req.userId = decoded.userId;
    next();
  } catch (error) {
    res.status(401).json({ message: '无效的令牌' });
  }
}

现在，你可以使用verifyToken中间件保护需要认证的路由：

app.use('/protected', verifyToken);

app.get('/protected', (req, res) => {
  res.json({ message: '欢迎，已认证用户！' });
});

3.2 处理错误和异常

在开发过程中，处理错误和异常是至关重要的。通过使用Express的错误处理器，我们可以优雅地处理各种错误情况：

app.use((err, req, res, next) => {
  console.error(err.stack);
  res.status(500).send('服务器内部错误');
});

4. 运行和测试API

最后，使用nodemon运行服务器：

nodemon server.ts

通过浏览器或Postman等工具访问你的API，验证其功能是否按预期工作。

结论

通过以上步骤，你已经成功地使用TypeScript和Express构建了一个基本的RESTful API，包括基础路由、用户认证和错误处理。TypeScript的静态类型系统和Express的强大功能相结合，使得构建健壮、可维护的API变得更加容易。随着项目规模的增长，你可以继续扩展这些基础功能，如增加更多路由、实现更复杂的业务逻辑和优化性能。