Stapi知识框架

news2025/5/14 7:04:47

一、Stapi 基础认知

1. 框架定位

自动化API开发框架：专注于快速生成RESTful API
约定优于配置：通过标准化约定减少样板代码
企业级应用支持：适合构建中大型API服务
代码生成导向：显著提升开发效率

2. 核心特性

自动CRUD端点生成
内置数据验证机制
标准化错误处理
数据库无关设计
可扩展的插件架构

二、项目结构

典型目录布局

/
├── entities/          # 数据实体定义
├── controllers/       # 自定义控制器
├── services/          # 业务逻辑层
├── repositories/      # 数据访问层
├── config/            # 配置文件
├── middlewares/       # 自定义中间件
└── app.js             # 应用入口

三、核心概念

1. 实体(Entities)

系统核心数据模型
自动映射为数据库表
示例定义：

@Entity()
export class User {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  name: string;

  @CreateDateColumn()
  createdAt: Date;
}

2. 控制器(Controllers)

处理HTTP请求
自动路由绑定
基础示例：

typescript

@Controller('users')
export class UsersController {
  constructor(private usersService: UsersService) {}

  @Get()
  findAll(): Promise<User[]> {
    return this.usersService.findAll();
  }
}

四、开发流程

1. 快速启动

# 安装CLI工具
npm install -g stapi-cli

# 创建新项目
stapi new project-name

# 生成资源
stapi generate resource user

2. 核心开发模式

定义数据实体
生成基础资源
定制业务逻辑
添加特殊路由
配置中间件

五、高级特性

1. 生命周期钩子

@BeforeCreate
@AfterUpdate
@BeforeRemove
自定义业务逻辑注入点

2. 查询构建器

复杂查询支持
关联数据加载
分页排序实现

getUsersWithPosts() {
  return this.userRepository
    .createQueryBuilder('user')
    .leftJoinAndSelect('user.posts', 'post')
    .where('user.isActive = :active', { active: true })
    .getMany();
}