开源项目 `staart/api` 使用教程

开源项目 staart/api 使用教程

api🏁🛠️ SaaS backend & API framework based on @nestjs项目地址:https://gitcode.com/gh_mirrors/api8/api

1. 项目的目录结构及介绍

staart/api/
├── src/
│   ├── config/
│   ├── controllers/
│   ├── middleware/
│   ├── models/
│   ├── routes/
│   ├── services/
│   ├── utils/
│   └── index.ts
├── public/
├── tests/
├── .env
├── .gitignore
├── package.json
├── tsconfig.json
└── README.md

• src/: 源代码目录，包含所有TypeScript文件。
  • config/: 配置文件目录，包含数据库、邮件等配置。
  • controllers/: 控制器目录，处理HTTP请求。
  • middleware/: 中间件目录，包含身份验证、日志等中间件。
  • models/: 数据模型目录，定义数据结构。
  • routes/: 路由目录，定义API路由。
  • services/: 服务目录，包含业务逻辑。
  • utils/: 工具函数目录，包含通用工具函数。
  • index.ts: 项目入口文件。
• public/: 静态文件目录，存放静态资源如图片、CSS等。
• tests/: 测试文件目录，包含单元测试和集成测试。
• .env: 环境变量文件，包含敏感信息如数据库密码等。
• .gitignore: Git忽略文件，指定不需要版本控制的文件和目录。
• package.json: 项目依赖和脚本配置文件。
• tsconfig.json: TypeScript配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts，它负责初始化Express应用、加载配置、连接数据库、注册路由和启动服务器。以下是 index.ts 的主要内容：

import express from 'express';
import { config } from './config';
import { connectDatabase } from './utils/database';
import { registerRoutes } from './routes';

const app = express();
const port = config.port || 3000;

// 加载中间件
app.use(express.json());
app.use(express.urlencoded({ extended: true }));

// 连接数据库
connectDatabase();

// 注册路由
registerRoutes(app);

// 启动服务器
app.listen(port, () => {
  console.log(`Server is running on http://localhost:${port}`);
});

3. 项目的配置文件介绍

项目的配置文件主要有两个：.env 和 src/config/index.ts。

.env

.env 文件用于存储环境变量，例如数据库连接字符串、端口号等。以下是一个示例：

PORT=3000
DATABASE_URL=mongodb://localhost:27017/mydatabase
JWT_SECRET=mysecret

src/config/index.ts

src/config/index.ts 文件用于读取和解析 .env 文件中的环境变量，并提供默认值。以下是 index.ts 的主要内容：

import dotenv from 'dotenv';

dotenv.config();

export const config = {
  port: process.env.PORT || 3000,
  databaseUrl: process.env.DATABASE_URL || 'mongodb://localhost:27017/mydatabase',
  jwtSecret: process.env.JWT_SECRET || 'mysecret',
};

通过这种方式，项目可以在不同的环境中灵活配置，同时保证敏感信息的安全。

api🏁🛠️ SaaS backend & API framework based on @nestjs项目地址:https://gitcode.com/gh_mirrors/api8/api