从零开始创建Express TypeScript Api项目

先决条件

• 安装nodejs
• 安装yarn npm install -g yarn

创建初始文件夹和 package.json

mkdir node-express-typescript-api && cd node-express-typescript-api && npm init

填写信息，将入口点设置为 index.ts 并为其他信息提供适当的值。

安装依赖

yarn add express
yarn add --dev typescript ts-node-dev @types/express @types/node

这仅适用于最低限度的设置，ts-node-dev依赖会不断地重新编译并直接运行 .ts 文件，而不是编译 .ts 文件然后运行 ​​.js 文件，它将是我们对仅适用于 .js 文件的 nodemon 的替代品。

创建一个tsconfig.json文件

npx tsc --init

这将使用默认设置自动为您创建一个 tsconfig.json（您可以随时更改它们）。

修改package.json中的脚本

使用您的代码编辑器或 IDE，修改脚本：在 package.json 中包含关键字和值，如下所示

"scripts": {
    "start": "ts-node-dev ./index.ts"
  },

创建index.ts文件

import express, { Application, Request, Response } from "express";

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

// Body parsing Middleware
app.use(express.json());
app.use(express.urlencoded({ extended: true }));

app.get(
    "/",
    async (req: Request, res: Response): Promise<Response> => {
        return res.status(200).send({
            message: "Hello World!",
        });
    }
);

try {
    app.listen(port, (): void => {
        console.log(`Connected successfully on port ${port}`);
    });
} catch (error) {
    console.error(`Error occured: ${error.message}`);
}

运行代码

要运行 Node express API，只需运行命令

npm run start