golang-yitisheng-server/server/docs/swagger.yaml

1492 lines
33 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

basePath: /api
definitions:
common.Response:
properties:
code:
type: integer
data: {}
message:
type: string
type: object
controller.UpdatePasswordRequest:
properties:
newPassword:
type: string
oldPassword:
type: string
required:
- newPassword
- oldPassword
type: object
dto.SaveScoreRequest:
properties:
ChineseScore:
type: number
CognitioPolyclinic:
type: string
CulturalScore:
type: number
EnglishScore:
type: number
ProfessionalCategory:
type: string
ProfessionalCategoryChildren:
items:
type: string
type: array
ProfessionalCategoryChildrenScore:
additionalProperties:
format: float64
type: number
type: object
ProfessionalScore:
type: number
Province:
type: string
SubjectList:
items:
type: string
type: array
createBy:
type: string
required:
- ChineseScore
- CognitioPolyclinic
- CulturalScore
- EnglishScore
- ProfessionalCategory
- ProfessionalCategoryChildren
- ProfessionalCategoryChildrenScore
- ProfessionalScore
- Province
- SubjectList
type: object
entity.SysUser:
properties:
activitiSync:
description: 同步工作流引擎
type: integer
avatar:
description: 头像
type: string
birthday:
description: 生日
type: string
bpmStatus:
description: 流程状态
type: string
clientId:
description: 设备ID
type: string
createBy:
description: 创建人
type: string
createTime:
description: 创建时间
type: string
delFlag:
description: 删除状态(0-正常,1-已删除)
type: integer
departIds:
description: 负责部门
type: string
dyOpenId:
description: 抖音openId
type: string
email:
description: 电子邮件
type: string
id:
type: string
ip:
description: 注册时ip
type: string
loginTenantId:
description: 上次登录租户ID
type: integer
orgCode:
description: 机构编码
type: string
phone:
description: 电话
type: string
programType:
description: 所属程序
type: string
realname:
description: 真实姓名
type: string
sex:
description: 性别(0-未知,1-男,2-女)
type: integer
showLinediff:
description: 是否显示历年线差
type: string
status:
description: 状态(1-正常,2-冻结)
type: integer
telephone:
description: 座机号
type: string
thirdId:
description: 第三方登录唯一标识
type: string
thirdType:
description: 第三方类型
type: string
updateBy:
description: 更新人
type: string
updateTime:
description: 更新时间
type: string
userIdentity:
description: 身份(1普通成员 2上级)
type: integer
username:
description: 登录账号
type: string
workNo:
description: 工号
type: string
wxOpenId:
description: 微信openId
type: string
type: object
entity.YxCalculationMajor:
properties:
batch:
type: string
category:
type: string
createTime:
type: string
detail:
type: string
enrollProbability:
type: number
enrollmentCode:
type: string
id:
type: string
kslx:
type: string
limitation:
type: string
mainSubjects:
type: string
majorCode:
type: string
majorName:
type: string
majorType:
type: string
majorTypeChild:
type: string
otherScoreLimitation:
type: string
planNum:
type: integer
privateProbabilityOperator:
type: string
privateRulesEnrollProbability:
type: string
privateStudentConvertedScore:
type: number
probabilityOperator:
type: string
rulesEnrollProbability:
type: string
rulesEnrollProbabilitySx:
type: string
schoolCode:
type: string
scoreId:
type: string
state:
type: string
studentConvertedScore:
type: number
studentOldConvertedScore:
type: number
tuition:
type: string
type: object
entity.YxHistoryMajorEnroll:
properties:
actualPitcherNum:
type: integer
admissionLine:
type: number
admissionNum:
type: integer
batch:
type: string
category:
type: string
checkMaster:
type: string
controlLine:
type: number
createBy:
type: string
createTime:
type: string
detail:
type: string
enrollNum:
type: integer
enrollmentCode:
type: string
id:
type: string
institutionCode:
type: string
mainSubjects:
type: string
majorCode:
type: string
majorName:
type: string
majorType:
type: string
majorTypeChild:
type: string
oneVolunteerAdmissionNum:
type: integer
probabilityOperator:
type: string
rulesEnrollProbability:
type: string
schoolCode:
type: string
schoolName:
type: string
scoreLineDifference:
type: number
sysOrgCode:
type: string
tuition:
type: string
updateBy:
type: string
updateTime:
type: string
year:
type: string
type: object
entity.YxSchoolMajor:
properties:
batch:
type: string
category:
type: string
checkMaster:
type: string
chineseScoreLimitation:
type: number
createBy:
type: string
createTime:
type: string
culturalControlLine:
type: number
culturalScoreLimitation:
type: number
detail:
type: string
englishScoreLimitation:
type: number
enrollmentCode:
type: string
id:
type: string
kslx:
type: string
limitation:
type: string
mainSubjects:
type: string
majorCode:
type: string
majorName:
type: string
majorType:
type: string
majorTypeChild:
type: string
planNum:
type: integer
privateProbabilityOperator:
type: string
privateRulesEnrollProbability:
type: string
probabilityOperator:
type: string
professionalScoreLimitation:
type: number
rulesEnrollProbability:
type: string
rulesEnrollProbabilitySx:
type: string
schoolCode:
type: string
schoolName:
type: string
semester:
type: string
specialControlLine:
type: number
state:
type: string
tuition:
type: string
updateBy:
type: string
updateTime:
type: string
type: object
entity.YxUserScore:
properties:
batch:
description: 录取批次
type: string
calculationTableName:
description: 记录结果表名
type: string
chineseScore:
description: 语文成绩
type: number
cognitioPolyclinic:
description: 文理分班(文科/理科)
type: string
createBy:
description: 创建人
type: string
createTime:
description: 创建时间
type: string
culturalScore:
description: 文化成绩分
type: number
educationalLevel:
description: 学历层次(1-本科,2-专科)
type: string
englishScore:
description: 英语成绩
type: number
fzby:
description: 服装表演
type: number
id:
type: string
jwtNum:
description: 较稳妥专业数量
type: integer
kbdNum:
description: 可保底专业数量
type: integer
kcjNum:
description: 可冲击专业数量
type: integer
nlqNum:
description: 难录取专业数量
type: integer
professionalCategory:
description: 专业类别(美术类/...)
type: string
professionalCategoryChildren:
description: 子级专业类别
type: string
professionalScore:
description: 专业成绩分
type: number
province:
description: 高考省份
type: string
ranking:
description: 位次
type: integer
state:
description: 状态(0-未使用,1-使用中)
type: string
subjects:
description: 选课
type: string
type:
description: 填报类型(1-普通类 2-艺术类)
type: string
updateBy:
description: 修改人
type: string
updateTime:
description: 修改时间
type: string
xjysby:
description: 戏剧影视表演
type: number
xjysdy:
description: 戏剧影视导演
type: number
yybyqy:
description: 音乐表演器乐
type: number
yybysy:
description: 音乐表演声乐
type: number
yyjy:
description: 音乐教育
type: number
type: object
entity.YxVolunteer:
properties:
createBy:
description: 创建人
type: string
createTime:
description: 创建日期
type: string
createType:
description: 生成类型(1.手动生成,2.智能生成)
type: string
id:
type: string
scoreId:
description: 使用成绩id
type: string
state:
description: 志愿单状态(0-否1.正在使用2-历史)
type: string
sysOrgCode:
description: 所属部门
type: string
updateBy:
description: 更新人
type: string
updateTime:
description: 更新日期
type: string
volunteerName:
description: 志愿单名称
type: string
type: object
entity.YxVolunteerRecord:
properties:
batch:
description: 录取批次
type: string
calculationMajorId:
description: 专业折算id
type: string
createBy:
description: 创建人
type: string
createTime:
description: 创建日期
type: string
enrollProbability:
description: 录取概率
type: number
enrollmentCode:
description: 招生代码
type: string
fctj:
description: 服从调剂
type: integer
id:
type: string
indexs:
description: 志愿顺序
type: integer
majorCode:
description: 专业编码
type: string
schoolCode:
description: 学校编码
type: string
studentConvertedScore:
description: 折合分数
type: number
volunteerId:
description: 志愿单id
type: string
type: object
server_modules_system_controller.LoginRequest:
properties:
password:
type: string
username:
type: string
required:
- password
- username
type: object
server_modules_user_controller.LoginRequest:
properties:
password:
type: string
username:
type: string
required:
- password
- username
type: object
host: localhost:8080
info:
contact: {}
description: 提供用户认证、院校专业、历年招生、计算专业的管理接口
title: 艺考招生管理系统 API
version: "2.0"
paths:
/sys-users:
get:
parameters:
- description: 页码
in: query
name: page
type: integer
- description: 每页数量
in: query
name: size
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 获取用户列表
tags:
- 用户管理
post:
parameters:
- description: 用户信息
in: body
name: item
required: true
schema:
$ref: '#/definitions/entity.SysUser'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 创建用户
tags:
- 用户管理
/sys-users/{id}:
delete:
parameters:
- description: 用户ID
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 删除用户
tags:
- 用户管理
get:
parameters:
- description: 用户ID
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 获取单个用户
tags:
- 用户管理
patch:
parameters:
- description: 用户ID
in: path
name: id
required: true
type: string
- description: 要更新的字段
in: body
name: fields
required: true
schema:
additionalProperties: true
type: object
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 动态字段更新
tags:
- 用户管理
put:
parameters:
- description: 用户ID
in: path
name: id
required: true
type: string
- description: 用户信息
in: body
name: item
required: true
schema:
$ref: '#/definitions/entity.SysUser'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 更新用户
tags:
- 用户管理
/sys-users/{id}/password:
put:
parameters:
- description: 用户ID
in: path
name: id
required: true
type: string
- description: 密码信息
in: body
name: request
required: true
schema:
$ref: '#/definitions/controller.UpdatePasswordRequest'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 修改密码
tags:
- 用户管理
/sys/auth/info:
get:
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: Sys获取当前登录用户信息
tags:
- 认证
/sys/auth/login:
post:
consumes:
- application/json
parameters:
- description: 登录信息
in: body
name: request
required: true
schema:
$ref: '#/definitions/server_modules_system_controller.LoginRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: Sys用户登录
tags:
- 认证
/sys/auth/logout:
post:
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: Sys用户登出
tags:
- 认证
/user/auth/info:
get:
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 获取当前登录用户信息
tags:
- 认证
/user/auth/login:
post:
consumes:
- application/json
parameters:
- description: 登录信息
in: body
name: request
required: true
schema:
$ref: '#/definitions/server_modules_user_controller.LoginRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 用户登录
tags:
- 认证
/user/auth/logout:
post:
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 用户登出
tags:
- 认证
/user/score/{id}:
get:
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 获取当前用户的当前分数
tags:
- 用户分数
/user/score/save-score:
post:
parameters:
- description: 成绩信息
in: body
name: request
required: true
schema:
$ref: '#/definitions/dto.SaveScoreRequest'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 保存用户成绩
tags:
- 用户分数
/yx-calculation-majors:
get:
parameters:
- description: 页码
in: query
name: page
type: integer
- description: 每页数量
in: query
name: size
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 获取计算专业列表
tags:
- 计算专业
post:
parameters:
- description: 计算专业信息
in: body
name: item
required: true
schema:
$ref: '#/definitions/entity.YxCalculationMajor'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 创建计算专业
tags:
- 计算专业
/yx-calculation-majors/{id}:
delete:
parameters:
- description: ID
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 删除计算专业
tags:
- 计算专业
get:
parameters:
- description: ID
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 获取单个计算专业
tags:
- 计算专业
patch:
parameters:
- description: ID
in: path
name: id
required: true
type: string
- description: 要更新的字段
in: body
name: fields
required: true
schema:
additionalProperties: true
type: object
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 动态字段更新
tags:
- 计算专业
put:
parameters:
- description: ID
in: path
name: id
required: true
type: string
- description: 计算专业信息
in: body
name: item
required: true
schema:
$ref: '#/definitions/entity.YxCalculationMajor'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 更新计算专业
tags:
- 计算专业
/yx-calculation-majors/batch:
delete:
parameters:
- description: ID列表
in: body
name: ids
required: true
schema:
items:
type: string
type: array
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 批量删除计算专业
tags:
- 计算专业
post:
parameters:
- description: 计算专业列表
in: body
name: items
required: true
schema:
items:
$ref: '#/definitions/entity.YxCalculationMajor'
type: array
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 批量创建计算专业
tags:
- 计算专业
/yx-history-enrolls:
get:
parameters:
- description: 页码
in: query
name: page
type: integer
- description: 每页数量
in: query
name: size
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 获取历年招生列表
tags:
- 历年招生
post:
parameters:
- description: 历年招生信息
in: body
name: item
required: true
schema:
$ref: '#/definitions/entity.YxHistoryMajorEnroll'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 创建历年招生记录
tags:
- 历年招生
/yx-history-enrolls/{id}:
delete:
parameters:
- description: ID
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 删除历年招生记录
tags:
- 历年招生
get:
parameters:
- description: ID
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 获取单个历年招生记录
tags:
- 历年招生
patch:
parameters:
- description: ID
in: path
name: id
required: true
type: string
- description: 要更新的字段
in: body
name: fields
required: true
schema:
additionalProperties: true
type: object
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 动态字段更新
tags:
- 历年招生
put:
parameters:
- description: ID
in: path
name: id
required: true
type: string
- description: 历年招生信息
in: body
name: item
required: true
schema:
$ref: '#/definitions/entity.YxHistoryMajorEnroll'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 更新历年招生记录
tags:
- 历年招生
/yx-history-enrolls/batch:
delete:
parameters:
- description: ID列表
in: body
name: ids
required: true
schema:
items:
type: string
type: array
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 批量删除历年招生记录
tags:
- 历年招生
post:
parameters:
- description: 历年招生列表
in: body
name: items
required: true
schema:
items:
$ref: '#/definitions/entity.YxHistoryMajorEnroll'
type: array
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 批量创建历年招生记录
tags:
- 历年招生
/yx-school-majors:
get:
parameters:
- description: 页码
in: query
name: page
type: integer
- description: 每页数量
in: query
name: size
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 获取院校专业列表
tags:
- 院校专业
post:
parameters:
- description: 院校专业信息
in: body
name: item
required: true
schema:
$ref: '#/definitions/entity.YxSchoolMajor'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 创建院校专业
tags:
- 院校专业
/yx-school-majors/{id}:
delete:
parameters:
- description: ID
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 删除院校专业
tags:
- 院校专业
get:
parameters:
- description: ID
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 获取单个院校专业
tags:
- 院校专业
patch:
parameters:
- description: ID
in: path
name: id
required: true
type: string
- description: 要更新的字段
in: body
name: fields
required: true
schema:
additionalProperties: true
type: object
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 动态字段更新
tags:
- 院校专业
put:
parameters:
- description: ID
in: path
name: id
required: true
type: string
- description: 院校专业信息
in: body
name: item
required: true
schema:
$ref: '#/definitions/entity.YxSchoolMajor'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 更新院校专业
tags:
- 院校专业
/yx-school-majors/batch:
delete:
parameters:
- description: ID列表
in: body
name: ids
required: true
schema:
items:
type: string
type: array
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 批量删除院校专业
tags:
- 院校专业
post:
parameters:
- description: 院校专业列表
in: body
name: items
required: true
schema:
items:
$ref: '#/definitions/entity.YxSchoolMajor'
type: array
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 批量创建院校专业
tags:
- 院校专业
/yx-user-scores:
get:
parameters:
- default: 1
description: 页码
in: query
name: page
type: integer
- default: 10
description: 每页数量
in: query
name: size
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 获取用户分数列表
tags:
- 用户分数
post:
parameters:
- description: 用户分数信息
in: body
name: item
required: true
schema:
$ref: '#/definitions/entity.YxUserScore'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 创建用户分数
tags:
- 用户分数
/yx-user-scores/{id}:
delete:
parameters:
- description: ID
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 删除用户分数
tags:
- 用户分数
get:
parameters:
- description: ID
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 获取单个用户分数
tags:
- 用户分数
put:
parameters:
- description: ID
in: path
name: id
required: true
type: string
- description: 用户分数信息
in: body
name: item
required: true
schema:
$ref: '#/definitions/entity.YxUserScore'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 更新用户分数
tags:
- 用户分数
/yx-volunteer-records:
get:
parameters:
- default: 1
description: 页码
in: query
name: page
type: integer
- default: 10
description: 每页数量
in: query
name: size
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 获取志愿明细列表
tags:
- 志愿明细
post:
parameters:
- description: 志愿明细信息
in: body
name: item
required: true
schema:
$ref: '#/definitions/entity.YxVolunteerRecord'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 创建志愿明细
tags:
- 志愿明细
/yx-volunteer-records/{id}:
delete:
parameters:
- description: ID
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 删除志愿明细
tags:
- 志愿明细
get:
parameters:
- description: ID
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 获取单个志愿明细
tags:
- 志愿明细
put:
parameters:
- description: ID
in: path
name: id
required: true
type: string
- description: 志愿明细信息
in: body
name: item
required: true
schema:
$ref: '#/definitions/entity.YxVolunteerRecord'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 更新志愿明细
tags:
- 志愿明细
/yx-volunteers:
get:
parameters:
- default: 1
description: 页码
in: query
name: page
type: integer
- default: 10
description: 每页数量
in: query
name: size
type: integer
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 获取志愿列表
tags:
- 志愿
post:
parameters:
- description: 志愿信息
in: body
name: item
required: true
schema:
$ref: '#/definitions/entity.YxVolunteer'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 创建志愿
tags:
- 志愿
/yx-volunteers/{id}:
delete:
parameters:
- description: ID
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 删除志愿
tags:
- 志愿
get:
parameters:
- description: ID
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 获取单个志愿
tags:
- 志愿
put:
parameters:
- description: ID
in: path
name: id
required: true
type: string
- description: 志愿信息
in: body
name: item
required: true
schema:
$ref: '#/definitions/entity.YxVolunteer'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 更新志愿
tags:
- 志愿
securityDefinitions:
Bearer:
in: header
name: Authorization
type: apiKey
swagger: "2.0"