Express TypeScript API

Express TypeScript API

一个支持 TypeScript 的空白 Express 服务器配置。

项目结构

express-typescript-api/
├── src/                  # Source files
│   ├── config/           # Configuration files
│   ├── routes/           # API routes
│   └── server.ts         # Express application setup
├── dist/                 # Compiled JavaScript files
├── .gitignore            # Git ignore file
├── package.json          # Project metadata and dependencies
├── tsconfig.json         # TypeScript configuration
└── README.md             # Project documentation

前置条件

• 推荐使用 Node.js（v14.x 或更高版本）
• npm（v6.x 或更高版本）

安装

1. 克隆仓库：

   git clone <repository-url>
   cd express-typescript-api
   

2. 安装依赖：

   npm install
   

开发

启动支持热重载的开发服务器：

npm run dev

服务器将在 http://localhost:3000 启动

构建生产版本

将 TypeScript 代码编译为 JavaScript：

npm run build

编译后的 JavaScript 文件将生成在 dist 目录中。

在生产环境中运行

在生产环境中运行编译后的 JavaScript：

npm start

可用的 API 端点

• GET /：返回欢迎消息
• GET /health：健康检查端点

环境变量

在根目录中创建 .env 文件，并添加以下变量：

NODE_ENV=development
PORT=3000

添加新路由

1. 在 src/routes 目录中创建新的路由文件
2. 在 src/server.ts 中导入并使用该路由

许可证

ISC