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

939 lines
21 KiB
YAML

basePath: /api
definitions:
common.Response:
properties:
code:
type: integer
data: {}
message:
type: string
type: object
controller.LoginRequest:
properties:
password:
type: string
username:
type: string
required:
- password
- username
type: object
controller.UpdatePasswordRequest:
properties:
newPassword:
type: string
oldPassword:
type: string
required:
- newPassword
- oldPassword
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
host: localhost:8080
info:
contact: {}
description: 提供用户认证、院校专业、历年招生、计算专业的管理接口
title: 艺考招生管理系统 API
version: "2.0"
paths:
/auth/info:
get:
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 获取当前登录用户信息
tags:
- 认证
/auth/login:
post:
consumes:
- application/json
parameters:
- description: 登录信息
in: body
name: request
required: true
schema:
$ref: '#/definitions/controller.LoginRequest'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 用户登录
tags:
- 认证
/auth/logout:
post:
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.Response'
summary: 用户登出
tags:
- 认证
/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:
- 用户管理
/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:
- 院校专业
securityDefinitions:
Bearer:
in: header
name: Authorization
type: apiKey
swagger: "2.0"