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

238 lines
7.6 KiB
JSON

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