如何使用 TypeScript 通过 Express 构建 Node.js API？

在构建 Node.js API 时，可以使用 TypeScript 来帮助更好地管理代码并提供更好的错误检查。同时，使用 Express 框架则能更方便地快速构建 API。

下面将介绍如何使用 TypeScript 和 Express 构建 Node.js API。

安装依赖

创建一个新的 Node.js 项目，并安装以下依赖：

npm install express typescript @types/express ts-node nodemon -D

• express：Express 框架。
• typescript：TypeScript 编译器。
• @types/express：Express 框架的 TypeScript 类型定义。
• ts-node：TypeScript 运行时。
• nodemon：Node.js 服务器自动重启工具，可以帮助在开发过程中快速更新 API。

配置 TypeScript

1. 创建 tsconfig.json 文件：

   {
     "compilerOptions": {
       "module": "commonjs",
       "esModuleInterop": true,
       "target": "es6",
       "moduleResolution": "node",
       "outDir": "./dist",
       "sourceMap": true
     },
     "include": [
       "./src/**/*"
     ]
   }
   

2. 创建 src/index.ts 入口文件：

   import express, { Request, Response } from 'express';
   
   const app = express();
   
   app.get('/', (req: Request, res: Response) => {
     res.send('Hello World!');
   });
   
   app.listen(3000, () => {
     console.log('Server running on port 3000');
   });
   

3. 创建 package.json 中的 scripts：

   {
     "scripts": {
       "start": "nodemon --exec ts-node src/index.ts"
     }
   }
   

编译 TypeScript

在终端中输入以下命令以编译 TypeScript 代码：

npx tsc

该命令将会生成 ./dist 目录，其中包含编译后的 JavaScript 代码。

运行 API

在终端中输入以下命令以运行 API：

npm start

现在，可以在浏览器中访问 http://localhost:3000 来查看 API。

Conclusion

以上就是使用 TypeScript 和 Express 构建 Node.js API 的全部流程。使用 TypeScript 能够使代码更加清晰易读，同时 TypeScript 还提供更好的错误检查和代码提示。使用 Express 则能够更方便地构建 Node.js API。