使用说明
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或更高版本)
安装
-
克隆存储库:
git clone <repository-url> cd express-typescript-api -
安装依赖项:
npm install
发展
要使用热重新加载启动开发服务器,请执行以下操作:
npm run dev
这将在以下位置启动服务器http://localhost:3000
生产大楼
要将TypeScript代码编译为JavaScript:
npm run build
这将在 dist 目录。
在生产中运行
要在生产环境中运行编译后的JavaScript:
npm start
可用的API端点
GET /:返回欢迎消息GET /health:健康检查端点
环境变量
创建一个 .env 根目录中的文件,包含以下变量:
NODE_ENV=development
PORT=3000
添加新路线
- 在中创建新的路线文件
src/routes目录 - 导入并使用路线
src/server.ts
许可证
国际协调委员会