sk-matrix-project/backend/golang/matrix-middle-service/docs/swagger.yaml

172 lines
3.8 KiB
YAML
Raw Normal View History

basePath: /
2023-02-27 17:18:31 +08:00
definitions:
2023-02-28 00:03:02 +08:00
bottype.AddBotTypeDto:
properties:
active:
description: 是否启用
type: boolean
name:
description: 名称
type: string
required:
- active
- name
type: object
2023-02-27 17:18:31 +08:00
errorx.CodeErrorResponse:
properties:
code:
2023-02-28 00:03:02 +08:00
description: 状态码
2023-02-27 17:18:31 +08:00
example: 200
type: integer
2023-02-28 00:03:02 +08:00
data:
description: 数据
2023-02-27 17:18:31 +08:00
msg:
2023-02-28 00:03:02 +08:00
description: 信息
2023-02-27 17:18:31 +08:00
example: OK
type: string
type: object
model.BotType:
properties:
active:
description: 是否启用
type: boolean
id:
description: id
type: string
name:
description: 名称
type: string
type: object
resp.Response:
properties:
code:
2023-02-28 00:03:02 +08:00
description: 状态码
2023-02-27 17:18:31 +08:00
example: 200
type: integer
2023-02-28 00:03:02 +08:00
data:
description: 数据
2023-02-27 17:18:31 +08:00
msg:
2023-02-28 00:03:02 +08:00
description: 信息
2023-02-27 17:18:31 +08:00
example: OK
type: string
type: object
info:
contact:
email: 919411476@qq.com
name: Shikong
description: matrix-middle-service 的 swagger
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
termsOfService: http://swagger.io/terms/
title: matrix-middle-service API
version: "1.0"
2023-02-27 17:18:31 +08:00
paths:
2023-02-28 00:03:02 +08:00
/bot/type/add:
post:
consumes:
- application/json
description: 添加 bot 类型
parameters:
- description: bot 类型
in: body
name: vo
required: true
schema:
$ref: '#/definitions/bottype.AddBotTypeDto'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/resp.Response'
- properties:
data:
type: boolean
type: object
default:
description: ""
schema:
$ref: '#/definitions/errorx.CodeErrorResponse'
summary: 添加 bot 类型
tags:
- BotType
/bot/type/del:
delete:
consumes:
- application/json
description: 根据 id 删除 bot 类型
parameters:
- description: bot 类型id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/resp.Response'
- properties:
data:
type: boolean
type: object
default:
description: ""
schema:
$ref: '#/definitions/errorx.CodeErrorResponse'
summary: 删除 bot 类型
tags:
- BotType
2023-02-27 17:18:31 +08:00
/bot/type/list:
get:
consumes:
- application/json
description: 获取 bot 类型列表
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/resp.Response'
- properties:
data:
items:
$ref: '#/definitions/model.BotType'
type: array
type: object
default:
description: ""
schema:
$ref: '#/definitions/errorx.CodeErrorResponse'
summary: 获取 bot 类型列表
tags:
- BotType
2023-03-14 19:10:45 +08:00
/record/location/post:
post:
consumes:
- application/json
description: 上报定位信息
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/resp.Response'
default:
description: ""
schema:
$ref: '#/definitions/errorx.CodeErrorResponse'
summary: 上报定位信息
tags:
- Record
swagger: "2.0"