71aaeb9424
- 新增 Dockerfile 和 .dockerignore 文件 - 添加 Gitea 持续集成工作流，用于构建和推送 Docker 镜像 - 新增 .gitignore 文件，忽略构建和配置文件 - 添加项目结构和规范文档，包括 TypeScript、模块化、API、数据库等规范 - 新增前端和后端的基础代码结构
22 lines
584 B
Markdown
22 lines
584 B
Markdown
# 接口定义规范
|
|
|
|
1. **DTO定义**
|
|
- 必须包含`description`字段说明用途
|
|
- 必须包含`example`字段提供示例值
|
|
- 示例:
|
|
```typescript
|
|
export const CreateUserDto = z.object({
|
|
username: z.string().min(3).max(20).openapi({
|
|
example: 'john_doe',
|
|
description: '用户名, 3-20个字符'
|
|
}),
|
|
password: z.string().min(6).openapi({
|
|
example: 'password123',
|
|
description: '密码, 最少6位'
|
|
})
|
|
})
|
|
```
|
|
|
|
2. **API响应**
|
|
- 统一的API响应格式
|
|
- 完善的Swagger文档 |