80 lines
2.3 KiB
YAML
80 lines
2.3 KiB
YAML
# 枚举配置文件映射示例
|
|
# 演示如何使用配置文件为枚举值定义有意义的键名和描述
|
|
|
|
generation:
|
|
models:
|
|
# 枚举键名映射配置
|
|
enum_key_mappings:
|
|
# 任务类型枚举
|
|
SysTaskTypeEnums:
|
|
- value: 1
|
|
name: SPOT_CHECK
|
|
description: 抽查
|
|
- value: 2
|
|
name: CULTURAL
|
|
description: 文创建设
|
|
- value: 3
|
|
name: CLASS_CADRE_MEETING
|
|
description: 班干部会议
|
|
- value: 4
|
|
name: CULTURAL_PROJECT
|
|
description: 文创项目
|
|
- value: 5
|
|
name: TEACHER_AWARD
|
|
description: 教工评优
|
|
- value: 6
|
|
name: CLASS_EVALUATION
|
|
description: 班级评比
|
|
- value: 7
|
|
name: ORGANIZATION_LIFE
|
|
description: 组织生活
|
|
|
|
# 系统角色枚举
|
|
SysRoleEnum:
|
|
- value: 1
|
|
name: ADMIN
|
|
description: 系统管理员
|
|
- value: 2
|
|
name: TEACHER
|
|
description: 教师
|
|
- value: 3
|
|
name: STUDENT
|
|
description: 学生
|
|
- value: 4
|
|
name: PARENT
|
|
description: 家长
|
|
|
|
# 班级类型枚举（字符串类型）
|
|
ClassTypeEnum:
|
|
- value: "PRIMARY"
|
|
name: PRIMARY_SCHOOL
|
|
description: 小学
|
|
- value: "MIDDLE"
|
|
name: MIDDLE_SCHOOL
|
|
description: 初中
|
|
- value: "HIGH"
|
|
name: HIGH_SCHOOL
|
|
description: 高中
|
|
|
|
# 状态枚举
|
|
StatusEnum:
|
|
- value: "active"
|
|
name: ACTIVE
|
|
description: 活跃状态
|
|
- value: "inactive"
|
|
name: INACTIVE
|
|
description: 非活跃状态
|
|
- value: "banned"
|
|
name: BANNED
|
|
description: 已封禁
|
|
|
|
# 使用说明：
|
|
# 1. 将需要映射的枚举名称作为键（必须与 Swagger 文档中的枚举名称完全匹配）
|
|
# 2. 为每个枚举值配置 value、name 和 description
|
|
# 3. value 必须与 Swagger 文档中的枚举值类型和值完全匹配
|
|
# 4. name 必须是有效的 Dart 标识符（大写字母+下划线）
|
|
# 5. description 是可选的，会生成为注释
|
|
# 6. 可以只配置部分枚举值，未配置的会使用 x-enum-varnames 或智能生成
|
|
# 7. 优先级：配置文件映射 > x-enum-varnames > 智能生成
|
|
|