// Package docs Code generated by swaggo/swag. DO NOT EDIT package docs import "github.com/swaggo/swag" const docTemplate = `{ "schemes": {{ marshal .Schemes }}, "swagger": "2.0", "info": { "description": "{{escape .Description}}", "title": "{{.Title}}", "contact": {}, "version": "{{.Version}}" }, "host": "{{.Host}}", "basePath": "{{.BasePath}}", "paths": { "/admin/app/create": { "post": { "security": [ { "LoginVerifyToken": [] } ], "description": "新增小程序", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端.小程序" ], "summary": "新增小程序", "parameters": [ { "description": "请求参数", "name": "RequestBody", "in": "body", "required": true, "schema": { "$ref": "#/definitions/app.createAppRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/app.createAppResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/code.Failure" } } } } }, "/admin/app/delete": { "post": { "security": [ { "LoginVerifyToken": [] } ], "description": "删除小程序", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端.小程序" ], "summary": "删除小程序", "parameters": [ { "description": "请求参数", "name": "RequestBody", "in": "body", "required": true, "schema": { "$ref": "#/definitions/app.deleteAppRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/app.deleteAppResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/code.Failure" } } } } }, "/admin/app/keyword": { "post": { "security": [ { "LoginVerifyToken": [] } ], "description": "添加意图关键字", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端.意图关键字" ], "summary": "添加意图关键字", "parameters": [ { "description": "请求参数", "name": "RequestBody", "in": "body", "required": true, "schema": { "$ref": "#/definitions/keyword.createKeywordRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/keyword.createKeywordResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/code.Failure" } } } } }, "/admin/app/keyword/material/{id}": { "put": { "security": [ { "LoginVerifyToken": [] } ], "description": "修改意图关键字素材", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端.意图关键字" ], "summary": "修改意图关键字素材", "parameters": [ { "type": "string", "description": "素材编号ID", "name": "id", "in": "path", "required": true }, { "description": "请求参数", "name": "RequestBody", "in": "body", "required": true, "schema": { "$ref": "#/definitions/keyword.modifyKeywordMaterialRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/keyword.modifyKeywordMaterialResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/code.Failure" } } } }, "post": { "security": [ { "LoginVerifyToken": [] } ], "description": "配置意图关键字素材", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端.意图关键字" ], "summary": "配置意图关键字素材", "parameters": [ { "type": "string", "description": "编号ID", "name": "id", "in": "path", "required": true }, { "description": "请求参数", "name": "RequestBody", "in": "body", "required": true, "schema": { "$ref": "#/definitions/keyword.createKeywordMaterialRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/keyword.createKeywordMaterialResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/code.Failure" } } } } }, "/admin/app/keyword/materials": { "get": { "security": [ { "LoginVerifyToken": [] } ], "description": "获取意图关键字素材列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端.意图关键字" ], "summary": "获取意图关键字素材列表", "parameters": [ { "type": "integer", "description": "意图关键字ID", "name": "keyword_id", "in": "query", "required": true }, { "type": "integer", "default": 1, "description": "当前页码", "name": "page", "in": "query", "required": true }, { "type": "integer", "default": 20, "description": "每页返回的数据量，最多 100 条", "name": "page_size", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/keyword.keywordMaterialPageListResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/code.Failure" } } } } }, "/admin/app/keyword/{id}": { "put": { "security": [ { "LoginVerifyToken": [] } ], "description": "修改意图关键字", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端.意图关键字" ], "summary": "修改意图关键字", "parameters": [ { "type": "string", "description": "编号ID", "name": "id", "in": "path", "required": true }, { "description": "请求参数", "name": "RequestBody", "in": "body", "required": true, "schema": { "$ref": "#/definitions/keyword.modifyKeywordRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/keyword.modifyKeywordResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/code.Failure" } } } }, "delete": { "security": [ { "LoginVerifyToken": [] } ], "description": "删除意图关键字", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端.意图关键字" ], "summary": "删除意图关键字", "parameters": [ { "type": "string", "description": "编号ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/keyword.deleteKeywordResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/code.Failure" } } } } }, "/admin/app/keywords": { "get": { "security": [ { "LoginVerifyToken": [] } ], "description": "获取意图关键字列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端.意图关键字" ], "summary": "获取意图关键字列表", "parameters": [ { "type": "integer", "description": "小程序ID", "name": "app_id", "in": "query", "required": true }, { "type": "string", "description": "意图关键字", "name": "keyword", "in": "query" }, { "type": "integer", "default": 1, "description": "当前页码", "name": "page", "in": "query", "required": true }, { "type": "integer", "default": 20, "description": "每页返回的数据量，最多 100 条", "name": "page_size", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/keyword.keywordPageListResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/code.Failure" } } } } }, "/admin/app/{id}": { "put": { "security": [ { "LoginVerifyToken": [] } ], "description": "编辑小程序", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端.小程序" ], "summary": "编辑小程序", "parameters": [ { "type": "string", "description": "编号ID", "name": "id", "in": "path", "required": true }, { "description": "请求参数", "name": "RequestBody", "in": "body", "required": true, "schema": { "$ref": "#/definitions/app.modifyAppRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/app.modifyAppResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/code.Failure" } } } } }, "/admin/apps": { "get": { "security": [ { "LoginVerifyToken": [] } ], "description": "小程序列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端.小程序" ], "summary": "小程序列表", "parameters": [ { "type": "string", "description": "小程序名称", "name": "name", "in": "query" }, { "type": "string", "description": "小程序ID", "name": "app_id", "in": "query" }, { "type": "integer", "default": 1, "description": "当前页码", "name": "page", "in": "query", "required": true }, { "type": "integer", "default": 20, "description": "每页返回的数据量，最多 100 条", "name": "page_size", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/app.listResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/code.Failure" } } } } }, "/admin/login": { "post": { "description": "管理员登录", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端.登录" ], "summary": "管理员登录", "parameters": [ { "description": "请求参数", "name": "RequestBody", "in": "body", "required": true, "schema": { "$ref": "#/definitions/admin.loginRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/admin.loginResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/code.Failure" } } } } }, "/admin/send_message": { "post": { "security": [ { "LoginVerifyToken": [] } ], "description": "管理员发送消息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端.小程序" ], "summary": "管理员发送消息", "parameters": [ { "description": "请求参数", "name": "RequestBody", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.adminSendMessageRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/message.adminSendMessageResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/code.Failure" } } } } }, "/admin/upload/image": { "post": { "description": "上传图片", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "tags": [ "通用" ], "summary": "上传图片", "parameters": [ { "type": "file", "description": "选择文件", "name": "file", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/upload.uploadImageResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/code.Failure" } } } } }, "/app/messages": { "get": { "description": "获取消息日志", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息日志" ], "summary": "获取消息日志", "parameters": [ { "type": "string", "description": "小程序ID", "name": "app_id", "in": "query", "required": true }, { "type": "string", "description": "用户ID", "name": "user_id", "in": "query", "required": true }, { "type": "integer", "default": 1, "description": "当前页码", "name": "page", "in": "query", "required": true }, { "type": "integer", "default": 20, "description": "每页返回的数据量，最多 100 条", "name": "page_size", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/message.appMessagePageListResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/code.Failure" } } } } }, "/app/send_message": { "post": { "description": "用户发送消息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "用户端" ], "summary": "用户发送消息", "parameters": [ { "description": "请求参数", "name": "RequestBody", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.userSendMessageRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/message.userSendMessageResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/code.Failure" } } } } }, "/app/user/create": { "post": { "description": "新增小程序用户", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "用户端" ], "summary": "新增小程序用户", "parameters": [ { "description": "请求参数", "name": "RequestBody", "in": "body", "required": true, "schema": { "$ref": "#/definitions/app.createAppUserRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/app.createAppUserResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/code.Failure" } } } } } }, "definitions": { "admin.loginRequest": { "type": "object", "required": [ "password", "username" ], "properties": { "password": { "description": "密码 (MD5加密后的密码)", "type": "string" }, "username": { "description": "用户名", "type": "string" } } }, "admin.loginResponse": { "type": "object", "properties": { "token": { "description": "登录成功后颁发的 Token", "type": "string" } } }, "app.createAppRequest": { "type": "object", "required": [ "app_id", "name" ], "properties": { "app_id": { "description": "小程序ID", "type": "string" }, "avatar": { "description": "头像", "type": "string" }, "description": { "description": "描述", "type": "string" }, "name": { "description": "名称", "type": "string" } } }, "app.createAppResponse": { "type": "object", "properties": { "message": { "description": "提示信息", "type": "string" } } }, "app.createAppUserRequest": { "type": "object", "required": [ "app_id", "user_id", "user_name" ], "properties": { "app_id": { "description": "小程序ID", "type": "string" }, "user_avatar": { "description": "用户头像", "type": "string" }, "user_id": { "description": "用户ID", "type": "string" }, "user_mobile": { "description": "用户手机号", "type": "string" }, "user_name": { "description": "用户昵称", "type": "string" } } }, "app.createAppUserResponse": { "type": "object", "properties": { "message": { "description": "提示信息", "type": "string" } } }, "app.deleteAppRequest": { "type": "object", "required": [ "ids" ], "properties": { "ids": { "description": "小程序编号(多个用,分割)", "type": "string" } } }, "app.deleteAppResponse": { "type": "object", "properties": { "message": { "description": "提示信息", "type": "string" } } }, "app.listData": { "type": "object", "properties": { "app_id": { "description": "小程序ID", "type": "string" }, "avatar": { "description": "小程序头像", "type": "string" }, "created_at": { "description": "创建时间", "type": "string" }, "description": { "description": "小程序描述", "type": "string" }, "id": { "description": "小程序编号", "type": "integer" }, "name": { "description": "小程序名称", "type": "string" }, "updated_at": { "description": "更新时间", "type": "string" } } }, "app.listResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/app.listData" } }, "page": { "description": "当前页码", "type": "integer" }, "page_size": { "description": "每页返回的数据量", "type": "integer" }, "total": { "description": "符合查询条件的总记录数", "type": "integer" } } }, "app.modifyAppRequest": { "type": "object", "required": [ "app_id", "name" ], "properties": { "app_id": { "description": "小程序ID", "type": "string" }, "avatar": { "description": "头像", "type": "string" }, "description": { "description": "描述", "type": "string" }, "name": { "description": "名称", "type": "string" } } }, "app.modifyAppResponse": { "type": "object", "properties": { "message": { "description": "提示信息", "type": "string" } } }, "code.Failure": { "type": "object", "properties": { "code": { "description": "业务码", "type": "integer" }, "message": { "description": "描述信息", "type": "string" } } }, "keyword.createKeywordMaterialRequest": { "type": "object", "required": [ "material_list" ], "properties": { "material_list": { "description": "素材列表", "type": "array", "items": { "$ref": "#/definitions/keyword.keywordMaterial" } } } }, "keyword.createKeywordMaterialResponse": { "type": "object", "properties": { "message": { "description": "提示信息", "type": "string" } } }, "keyword.createKeywordRequest": { "type": "object", "required": [ "app_id", "keyword" ], "properties": { "app_id": { "description": "小程序ID", "type": "string" }, "keyword": { "description": "关键字", "type": "string" } } }, "keyword.createKeywordResponse": { "type": "object", "properties": { "id": { "description": "关键字ID", "type": "integer" }, "message": { "description": "提示信息", "type": "string" } } }, "keyword.deleteKeywordResponse": { "type": "object", "properties": { "message": { "description": "提示信息", "type": "string" } } }, "keyword.keywordListData": { "type": "object", "properties": { "app_id": { "description": "小程序ID", "type": "string" }, "created_at": { "description": "创建时间", "type": "string" }, "created_user": { "description": "创建人", "type": "string" }, "id": { "description": "关键字编号", "type": "integer" }, "keyword": { "description": "意图关键字", "type": "string" }, "material_type_count": { "description": "素材类型数量", "type": "string" }, "updated_at": { "description": "更新时间", "type": "string" }, "updated_user": { "description": "更新人", "type": "string" } } }, "keyword.keywordMaterial": { "type": "object", "required": [ "content", "interval_seconds", "type" ], "properties": { "content": { "description": "素材内容", "type": "string" }, "interval_seconds": { "description": "发送间隔时间(单位:秒)", "type": "integer" }, "type": { "description": "素材类型(1:文本 2:图片)", "type": "integer" } } }, "keyword.keywordMaterialListData": { "type": "object", "properties": { "content": { "description": "素材内容", "type": "string" }, "created_at": { "description": "创建时间", "type": "string" }, "created_user": { "description": "创建人", "type": "string" }, "id": { "description": "主键ID", "type": "integer" }, "interval_seconds": { "description": "素材发送间隔时间(单位:秒)", "type": "integer" }, "keyword_id": { "description": "意图关键字ID", "type": "integer" }, "type": { "description": "素材类型(1:文本 2:图片)", "type": "integer" } } }, "keyword.keywordMaterialPageListResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/keyword.keywordMaterialListData" } }, "page": { "description": "当前页码", "type": "integer" }, "page_size": { "description": "每页返回的数据量", "type": "integer" }, "total": { "description": "符合查询条件的总记录数", "type": "integer" } } }, "keyword.keywordPageListResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/keyword.keywordListData" } }, "page": { "description": "当前页码", "type": "integer" }, "page_size": { "description": "每页返回的数据量", "type": "integer" }, "total": { "description": "符合查询条件的总记录数", "type": "integer" } } }, "keyword.modifyKeywordMaterialRequest": { "type": "object", "required": [ "content", "interval_seconds", "type" ], "properties": { "content": { "description": "素材内容", "type": "string" }, "interval_seconds": { "description": "发送间隔时间(单位:秒)", "type": "integer" }, "type": { "description": "素材类型(1:文本 2:图片)", "type": "integer" } } }, "keyword.modifyKeywordMaterialResponse": { "type": "object", "properties": { "message": { "description": "提示信息", "type": "string" } } }, "keyword.modifyKeywordRequest": { "type": "object", "required": [ "keyword" ], "properties": { "keyword": { "description": "意图关键字", "type": "string" } } }, "keyword.modifyKeywordResponse": { "type": "object", "properties": { "message": { "description": "提示信息", "type": "string" } } }, "message.adminSendMessageRequest": { "type": "object", "required": [ "app_id", "content", "msg_type", "to_user_id" ], "properties": { "app_id": { "description": "小程序ID", "type": "string" }, "content": { "description": "内容", "type": "string" }, "msg_type": { "description": "消息类型(1:文本 2:图片)", "type": "integer" }, "to_user_id": { "description": "接收用户ID", "type": "string" } } }, "message.adminSendMessageResponse": { "type": "object", "properties": { "message": { "description": "提示信息", "type": "string" } } }, "message.appMessagePageListResponse": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/message.listMessageData" } }, "page": { "description": "当前页码", "type": "integer" }, "page_size": { "description": "每页返回的数据量", "type": "integer" }, "total": { "description": "符合查询条件的总记录数", "type": "integer" } } }, "message.listMessageData": { "type": "object", "properties": { "content": { "description": "消息内容", "type": "string" }, "msg_type": { "description": "消息类型(1:文本 2:图片)", "type": "integer" }, "receiver_id": { "description": "接收人ID", "type": "string" }, "send_time": { "description": "发送时间", "type": "string" }, "sender_id": { "description": "发送人ID", "type": "string" }, "sender_name": { "description": "发送人昵称", "type": "string" } } }, "message.userSendMessageRequest": { "type": "object", "required": [ "app_id", "content", "from_user_id", "from_user_name", "msg_type" ], "properties": { "app_id": { "description": "小程序ID", "type": "string" }, "content": { "description": "内容", "type": "string" }, "from_user_id": { "description": "发送用户的ID", "type": "string" }, "from_user_name": { "description": "发送用户的昵称", "type": "string" }, "msg_type": { "description": "消息类型(1:文本 2:图片)", "type": "integer" } } }, "message.userSendMessageResponse": { "type": "object", "properties": { "message": { "description": "提示信息", "type": "string" } } }, "upload.uploadImageResponse": { "type": "object", "properties": { "preview_image_url": { "description": "可预览图片地址", "type": "string" }, "real_image_url": { "description": "真实图片地址", "type": "string" } } } }, "securityDefinitions": { "LoginVerifyToken": { "type": "apiKey", "name": "Authorization", "in": "header" } } }` // SwaggerInfo holds exported Swagger Info so clients can modify it var SwaggerInfo = &swag.Spec{ Version: "v0.0.1", Host: "", BasePath: "/", Schemes: []string{}, Title: "mini-chat 接口文档", Description: "", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, LeftDelim: "{{", RightDelim: "}}", } func init() { swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo) }