swagger_generator_flutter/example/swagger_enum_example.json

86 lines
2.0 KiB
JSON

{
"openapi": "3.0.1",
"info": {
"title": "枚举键名示例 API",
"version": "v1",
"description": "演示如何使用 x-enum-varnames 和 x-enum-descriptions 生成有意义的枚举键名"
},
"paths": {},
"components": {
"schemas": {
"SysTaskTypeEnums": {
"enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, -1],
"type": "integer",
"description": "任务类型枚举",
"format": "int32",
"x-enum-varnames": [
"SPOT_CHECK",
"CULTURAL",
"CLASS_CADRE_MEETING",
"STUDENT_TALK",
"FOLLOW_CLASS",
"TEACHER_BEHAVIOR_OBSERVATION",
"MEETING",
"COACH_SUBJECT",
"DATA_COLLECTION",
"CLASS_MEETING",
"TEACHER_TALK",
"OTHER_WORK",
"CLASS_ACTIVITY",
"UNKNOWN"
],
"x-enum-descriptions": [
"抽查",
"文创建设",
"班干部会议",
"学生谈话",
"双师跟课",
"教师行为观察",
"参加会议",
"学科辅助",
"数据采集",
"召开班会",
"教师谈话",
"其他工作",
"班级活动",
"未知类型"
]
},
"SysRoleEnum": {
"enum": [1, 2, 3, 4],
"type": "integer",
"description": "系统角色枚举",
"format": "int32",
"x-enum-varnames": [
"ADMIN",
"TEACHER",
"STUDENT",
"PARENT"
],
"x-enum-descriptions": [
"系统管理员",
"教师",
"学生",
"家长"
]
},
"ClassTypeEnum": {
"enum": ["PRIMARY", "MIDDLE", "HIGH"],
"type": "string",
"description": "班级类型枚举",
"x-enum-varnames": [
"PRIMARY_SCHOOL",
"MIDDLE_SCHOOL",
"HIGH_SCHOOL"
],
"x-enum-descriptions": [
"小学",
"初中",
"高中"
]
}
}
}
}