1041 lines
24 KiB
YAML
1041 lines
24 KiB
YAML
basePath: /
|
||
definitions:
|
||
dto.AddTrainReqDto:
|
||
properties:
|
||
headLinkId:
|
||
description: 车头所在link的索引
|
||
type: string
|
||
headLinkOffset:
|
||
description: 车头所在link内的偏移量,单位为mm
|
||
type: integer
|
||
simulationId:
|
||
description: 仿真id
|
||
type: string
|
||
up:
|
||
description: 列车方向,true-上行,false-下行
|
||
type: boolean
|
||
type: object
|
||
dto.AddTrainRspDto:
|
||
properties:
|
||
simulationId:
|
||
description: 仿真id
|
||
type: string
|
||
trainId:
|
||
description: 新添加的列车的索引
|
||
type: string
|
||
type: object
|
||
dto.CheckMapDataReqDto:
|
||
properties:
|
||
data:
|
||
items:
|
||
type: integer
|
||
type: array
|
||
required:
|
||
- data
|
||
type: object
|
||
dto.CheckMapDataRspDto:
|
||
properties:
|
||
errors:
|
||
items:
|
||
type: string
|
||
type: array
|
||
success:
|
||
type: boolean
|
||
type: object
|
||
dto.ErrorDto:
|
||
properties:
|
||
code:
|
||
type: integer
|
||
message:
|
||
type: string
|
||
type: object
|
||
dto.LoginDto:
|
||
properties:
|
||
account:
|
||
description: 账号
|
||
example: "17791995809"
|
||
type: string
|
||
password:
|
||
description: 加密密码
|
||
example: 95129dbaace576e46f41a629e6f35d5c
|
||
type: string
|
||
required:
|
||
- account
|
||
- password
|
||
type: object
|
||
dto.OrderItem:
|
||
properties:
|
||
asc:
|
||
type: boolean
|
||
column:
|
||
type: string
|
||
type: object
|
||
dto.PageDto:
|
||
properties:
|
||
orders:
|
||
description: 排序项
|
||
items:
|
||
$ref: '#/definitions/dto.OrderItem'
|
||
type: array
|
||
page:
|
||
description: 页码
|
||
example: 1
|
||
type: integer
|
||
records: {}
|
||
size:
|
||
description: 页面行数
|
||
example: 10
|
||
type: integer
|
||
total:
|
||
type: integer
|
||
required:
|
||
- page
|
||
- size
|
||
type: object
|
||
dto.RegisterUser:
|
||
properties:
|
||
id:
|
||
type: integer
|
||
mobile:
|
||
description: 手机号
|
||
type: string
|
||
name:
|
||
description: 名字
|
||
type: string
|
||
password:
|
||
description: 密码
|
||
type: string
|
||
register_time:
|
||
description: 注册时间
|
||
type: string
|
||
type: object
|
||
dto.RemoveTrainDto:
|
||
properties:
|
||
simulationId:
|
||
description: 仿真id
|
||
type: string
|
||
trainId:
|
||
description: 新添加的列车的索引
|
||
type: string
|
||
type: object
|
||
dto.SimulationCreateReqDto:
|
||
properties:
|
||
mapId:
|
||
description: 地图id
|
||
type: integer
|
||
type: object
|
||
dto.SimulationCreateRspDto:
|
||
properties:
|
||
mapId:
|
||
description: 地图id
|
||
type: integer
|
||
simulationId:
|
||
description: 仿真id
|
||
type: string
|
||
type: object
|
||
dto.SimulationInfoRepDto:
|
||
properties:
|
||
mapId:
|
||
type: string
|
||
simulationId:
|
||
type: string
|
||
type: object
|
||
dto.SwitchOperationReqDto:
|
||
properties:
|
||
simulationId:
|
||
type: string
|
||
switchIndex:
|
||
type: string
|
||
turnNormal:
|
||
type: boolean
|
||
turnReverse:
|
||
type: boolean
|
||
required:
|
||
- simulationId
|
||
- switchIndex
|
||
- turnNormal
|
||
- turnReverse
|
||
type: object
|
||
dto.TokenRespDto:
|
||
properties:
|
||
code:
|
||
type: integer
|
||
expire:
|
||
type: string
|
||
token:
|
||
type: string
|
||
type: object
|
||
model.Drafting:
|
||
properties:
|
||
created_at:
|
||
description: 创建时间
|
||
type: string
|
||
creator_id:
|
||
description: 创建人id
|
||
type: integer
|
||
id:
|
||
description: id
|
||
type: integer
|
||
name:
|
||
description: 草稿图名称
|
||
type: string
|
||
proto:
|
||
description: 绘图数据
|
||
items:
|
||
type: integer
|
||
type: array
|
||
update_at:
|
||
description: 修改时间
|
||
type: string
|
||
type: object
|
||
model.PublishedGi:
|
||
properties:
|
||
id:
|
||
description: id
|
||
type: integer
|
||
name:
|
||
description: 发布图形界面名称
|
||
type: string
|
||
proto:
|
||
description: 图形界面数据
|
||
items:
|
||
type: integer
|
||
type: array
|
||
publish_at:
|
||
description: 发布时间
|
||
type: string
|
||
user_id:
|
||
description: 发布用户id
|
||
type: integer
|
||
type: object
|
||
host: localhost:8080
|
||
info:
|
||
contact: {}
|
||
description: CBTC测试服务.
|
||
title: CBTC测试系统API
|
||
version: "1.0"
|
||
paths:
|
||
/api/v1/drafting:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 创建草稿数据
|
||
parameters:
|
||
- in: query
|
||
name: id
|
||
type: integer
|
||
- in: query
|
||
name: name
|
||
type: string
|
||
- collectionFormat: csv
|
||
in: query
|
||
items:
|
||
type: integer
|
||
name: proto
|
||
type: array
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
"401":
|
||
description: Unauthorized
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"404":
|
||
description: Not Found
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
security:
|
||
- JwtAuth: []
|
||
summary: 创建草稿
|
||
tags:
|
||
- 草稿Api
|
||
/api/v1/drafting/:id:
|
||
delete:
|
||
consumes:
|
||
- application/json
|
||
description: 删除草稿数据
|
||
parameters:
|
||
- description: 草稿ID
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: integer
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
"401":
|
||
description: Unauthorized
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"404":
|
||
description: Not Found
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
security:
|
||
- JwtAuth: []
|
||
summary: 删除草稿数据
|
||
tags:
|
||
- 草稿Api
|
||
get:
|
||
consumes:
|
||
- application/json
|
||
description: 查询草稿详情
|
||
parameters:
|
||
- description: 草稿ID
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: integer
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
schema:
|
||
$ref: '#/definitions/model.Drafting'
|
||
"401":
|
||
description: Unauthorized
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"404":
|
||
description: Not Found
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
security:
|
||
- JwtAuth: []
|
||
summary: 查询草稿详情
|
||
tags:
|
||
- 草稿Api
|
||
put:
|
||
consumes:
|
||
- application/json
|
||
description: 修改草稿信息
|
||
parameters:
|
||
- description: 草稿ID
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: integer
|
||
- in: query
|
||
name: id
|
||
type: integer
|
||
- in: query
|
||
name: name
|
||
type: string
|
||
- collectionFormat: csv
|
||
in: query
|
||
items:
|
||
type: integer
|
||
name: proto
|
||
type: array
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
"401":
|
||
description: Unauthorized
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"404":
|
||
description: Not Found
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
security:
|
||
- JwtAuth: []
|
||
summary: 修改草稿信息
|
||
tags:
|
||
- 草稿Api
|
||
/api/v1/drafting/:id/saveAs:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 草稿另存为
|
||
parameters:
|
||
- description: 源草稿id
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: integer
|
||
- in: query
|
||
name: id
|
||
type: integer
|
||
- in: query
|
||
name: name
|
||
type: string
|
||
- collectionFormat: csv
|
||
in: query
|
||
items:
|
||
type: integer
|
||
name: proto
|
||
type: array
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
"401":
|
||
description: Unauthorized
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"404":
|
||
description: Not Found
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
security:
|
||
- JwtAuth: []
|
||
summary: 草稿另存为
|
||
tags:
|
||
- 草稿Api
|
||
/api/v1/drafting/paging:
|
||
get:
|
||
consumes:
|
||
- application/json
|
||
description: 可以通过草稿名称过滤,分页查询草稿
|
||
parameters:
|
||
- in: query
|
||
name: name
|
||
type: string
|
||
- description: 页码
|
||
example: 1
|
||
in: query
|
||
name: page
|
||
required: true
|
||
type: integer
|
||
- description: 页面行数
|
||
example: 10
|
||
in: query
|
||
name: size
|
||
required: true
|
||
type: integer
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
schema:
|
||
$ref: '#/definitions/dto.PageDto'
|
||
"401":
|
||
description: Unauthorized
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"404":
|
||
description: Not Found
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
security:
|
||
- JwtAuth: []
|
||
summary: 分页查询草稿
|
||
tags:
|
||
- 草稿Api
|
||
/api/v1/publishedGi/{id}:
|
||
delete:
|
||
consumes:
|
||
- application/json
|
||
description: 可以通过名称过滤
|
||
parameters:
|
||
- description: JWT Token
|
||
in: header
|
||
name: Authorization
|
||
required: true
|
||
type: string
|
||
- description: id
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: integer
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
"401":
|
||
description: Unauthorized
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"404":
|
||
description: Not Found
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
security:
|
||
- JwtAuth: []
|
||
summary: id查询发布的图形数据
|
||
tags:
|
||
- 发布的图形数据Api
|
||
get:
|
||
consumes:
|
||
- application/json
|
||
description: 可以通过名称过滤
|
||
parameters:
|
||
- description: JWT Token
|
||
in: header
|
||
name: Authorization
|
||
required: true
|
||
type: string
|
||
- description: id
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: integer
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
schema:
|
||
$ref: '#/definitions/model.PublishedGi'
|
||
"401":
|
||
description: Unauthorized
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"404":
|
||
description: Not Found
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
security:
|
||
- JwtAuth: []
|
||
summary: id查询发布的图形数据
|
||
tags:
|
||
- 发布的图形数据Api
|
||
/api/v1/publishedGi/list:
|
||
get:
|
||
consumes:
|
||
- application/json
|
||
description: 可以通过名称过滤
|
||
parameters:
|
||
- description: JWT Token
|
||
in: header
|
||
name: Authorization
|
||
required: true
|
||
type: string
|
||
- in: query
|
||
name: name
|
||
type: string
|
||
- description: 页码
|
||
example: 1
|
||
in: query
|
||
name: page
|
||
required: true
|
||
type: integer
|
||
- description: 页面行数
|
||
example: 10
|
||
in: query
|
||
name: size
|
||
required: true
|
||
type: integer
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
schema:
|
||
items:
|
||
$ref: '#/definitions/model.PublishedGi'
|
||
type: array
|
||
"401":
|
||
description: Unauthorized
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"404":
|
||
description: Not Found
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
security:
|
||
- JwtAuth: []
|
||
summary: 列表查询发布的图形数据
|
||
tags:
|
||
- 发布的图形数据Api
|
||
/api/v1/publishedGi/paging:
|
||
get:
|
||
consumes:
|
||
- application/json
|
||
description: 可以通过名称过滤
|
||
parameters:
|
||
- description: JWT Token
|
||
in: header
|
||
name: Authorization
|
||
required: true
|
||
type: string
|
||
- in: query
|
||
name: name
|
||
type: string
|
||
- description: 页码
|
||
example: 1
|
||
in: query
|
||
name: page
|
||
required: true
|
||
type: integer
|
||
- description: 页面行数
|
||
example: 10
|
||
in: query
|
||
name: size
|
||
required: true
|
||
type: integer
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
schema:
|
||
$ref: '#/definitions/dto.PageDto'
|
||
"401":
|
||
description: Unauthorized
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"404":
|
||
description: Not Found
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
security:
|
||
- JwtAuth: []
|
||
summary: 分页查询发布的图形数据
|
||
tags:
|
||
- 发布的图形数据Api
|
||
/api/v1/publishedGi/publish:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
parameters:
|
||
- description: JWT Token
|
||
in: header
|
||
name: Authorization
|
||
required: true
|
||
type: string
|
||
- description: 草稿数据的id
|
||
in: query
|
||
name: draftId
|
||
type: integer
|
||
- description: 发布后的名称
|
||
in: query
|
||
name: name
|
||
type: string
|
||
- description: 是否覆盖同名数据
|
||
in: query
|
||
name: overwrite
|
||
type: boolean
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
"401":
|
||
description: Unauthorized
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"404":
|
||
description: Not Found
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
security:
|
||
- JwtAuth: []
|
||
summary: 从草稿发布数据
|
||
tags:
|
||
- 发布的图形数据Api
|
||
/api/v1/simulation/check/data:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: ATS测试仿真-添加列车
|
||
parameters:
|
||
- description: JWT Token
|
||
in: header
|
||
name: Authorization
|
||
required: true
|
||
type: string
|
||
- description: ATS测试仿真-地图数据
|
||
in: body
|
||
name: RemoveTrainDto
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.CheckMapDataReqDto'
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
schema:
|
||
$ref: '#/definitions/dto.CheckMapDataRspDto'
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
security:
|
||
- JwtAuth: []
|
||
summary: ATS测试仿真地图数据校验
|
||
tags:
|
||
- ATS测试仿真Api
|
||
/api/v1/simulation/create:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 创建ATS测试仿真
|
||
parameters:
|
||
- description: JWT Token
|
||
in: header
|
||
name: Authorization
|
||
required: true
|
||
type: string
|
||
- description: 创建仿真请求
|
||
in: body
|
||
name: SimulationCreateReqDto
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.SimulationCreateReqDto'
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
schema:
|
||
$ref: '#/definitions/dto.SimulationCreateRspDto'
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
security:
|
||
- JwtAuth: []
|
||
summary: 创建ATS测试仿真
|
||
tags:
|
||
- ATS测试仿真Api
|
||
/api/v1/simulation/list:
|
||
get:
|
||
consumes:
|
||
- application/json
|
||
description: ATS测试仿真-添加列车
|
||
parameters:
|
||
- description: JWT Token
|
||
in: header
|
||
name: Authorization
|
||
required: true
|
||
type: string
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
schema:
|
||
items:
|
||
$ref: '#/definitions/dto.SimulationInfoRepDto'
|
||
type: array
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
security:
|
||
- JwtAuth: []
|
||
summary: 获取ATS测试系统所有仿真实例的基本信息
|
||
tags:
|
||
- ATS测试仿真Api
|
||
/api/v1/simulation/switch/operation:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: ATS测试仿真-添加列车
|
||
parameters:
|
||
- description: JWT Token
|
||
in: header
|
||
name: Authorization
|
||
required: true
|
||
type: string
|
||
- description: ATS测试仿真-操作道岔
|
||
in: body
|
||
name: RemoveTrainDto
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.SwitchOperationReqDto'
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
schema:
|
||
type: string
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
security:
|
||
- JwtAuth: []
|
||
summary: 获取ATS测试-操作道岔
|
||
tags:
|
||
- ATS测试仿真Api
|
||
/api/v1/simulation/train/add:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: ATS测试仿真-添加列车
|
||
parameters:
|
||
- description: JWT Token
|
||
in: header
|
||
name: Authorization
|
||
required: true
|
||
type: string
|
||
- description: ATS测试仿真-添加列车
|
||
in: body
|
||
name: AddTrainReqDto
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.AddTrainReqDto'
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
schema:
|
||
$ref: '#/definitions/dto.AddTrainRspDto'
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
security:
|
||
- JwtAuth: []
|
||
summary: ATS测试仿真-添加列车
|
||
tags:
|
||
- ATS测试仿真Api
|
||
/api/v1/simulation/train/destroy/{id}:
|
||
get:
|
||
consumes:
|
||
- application/json
|
||
description: ATS测试仿真-添加列车
|
||
parameters:
|
||
- description: JWT Token
|
||
in: header
|
||
name: Authorization
|
||
required: true
|
||
type: string
|
||
- description: 仿真id
|
||
in: path
|
||
name: id
|
||
required: true
|
||
type: integer
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
schema:
|
||
type: string
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
security:
|
||
- JwtAuth: []
|
||
summary: ATS仿真销毁
|
||
tags:
|
||
- ATS测试仿真Api
|
||
/api/v1/simulation/train/remove:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: ATS测试仿真-移除列车
|
||
parameters:
|
||
- description: JWT Token
|
||
in: header
|
||
name: Authorization
|
||
required: true
|
||
type: string
|
||
- description: ATS测试仿真-移除列车
|
||
in: body
|
||
name: RemoveTrainDto
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.RemoveTrainDto'
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
schema:
|
||
type: string
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
security:
|
||
- JwtAuth: []
|
||
summary: ATS测试仿真-移除列车
|
||
tags:
|
||
- ATS测试仿真Api
|
||
/api/v1/user/current:
|
||
get:
|
||
consumes:
|
||
- application/json
|
||
description: 获取当前登录用户信息
|
||
parameters:
|
||
- description: JWT Token
|
||
in: header
|
||
name: Authorization
|
||
required: true
|
||
type: string
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
schema:
|
||
$ref: '#/definitions/dto.RegisterUser'
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
summary: 获取当前登录用户信息
|
||
tags:
|
||
- 用户Api
|
||
/api/v1/user/login:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 用户登录
|
||
parameters:
|
||
- description: 登录信息
|
||
in: body
|
||
name: loginInfo
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.LoginDto'
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
schema:
|
||
$ref: '#/definitions/dto.TokenRespDto'
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
summary: 用户登录
|
||
tags:
|
||
- 用户Api
|
||
/api/v1/user/paging:
|
||
get:
|
||
consumes:
|
||
- application/json
|
||
description: 可以通过用户名称过滤,分页查询用户
|
||
parameters:
|
||
- description: 手机号
|
||
in: query
|
||
name: mobile
|
||
type: string
|
||
- description: 用户名
|
||
in: query
|
||
name: name
|
||
type: string
|
||
- description: 页码
|
||
example: 1
|
||
in: query
|
||
name: page
|
||
required: true
|
||
type: integer
|
||
- description: 页面行数
|
||
example: 10
|
||
in: query
|
||
name: size
|
||
required: true
|
||
type: integer
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
schema:
|
||
$ref: '#/definitions/dto.PageDto'
|
||
"401":
|
||
description: Unauthorized
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"404":
|
||
description: Not Found
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
security:
|
||
- JwtAuth: []
|
||
summary: 分页查询用户
|
||
tags:
|
||
- 用户Api
|
||
/api/v1/user/register:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 用户注册
|
||
parameters:
|
||
- description: 用户注册信息
|
||
in: body
|
||
name: loginInfo
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/dto.RegisterUser'
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: OK
|
||
schema:
|
||
type: string
|
||
"500":
|
||
description: Internal Server Error
|
||
schema:
|
||
$ref: '#/definitions/dto.ErrorDto'
|
||
summary: 用户注册
|
||
tags:
|
||
- 用户Api
|
||
securityDefinitions:
|
||
JwtAuth:
|
||
in: header
|
||
name: Authorization
|
||
type: apiKey
|
||
swagger: "2.0"
|