590 lines
14 KiB
YAML
590 lines
14 KiB
YAML
basePath: /
|
|
definitions:
|
|
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.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:
|
|
get:
|
|
consumes:
|
|
- application/json
|
|
description: 查询草稿详情
|
|
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:
|
|
- 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:
|
|
- 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: 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: 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: query
|
|
name: token
|
|
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:
|
|
- 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: 草稿数据的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/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
|
|
securityDefinitions:
|
|
JwtAuth:
|
|
in: header
|
|
name: Authorization
|
|
type: apiKey
|
|
swagger: "2.0"
|