{ "swagger": "2.0", "info": { "description": "Video Course框架 API 文档", "title": "Video Course框架", "termsOfService": "http://swagger.io/terms/", "contact": { "name": "API Support", "url": "http://www.swagger.io/support", "email": "support@swagger.io" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0" }, "basePath": "/v1", "paths": { "/Auth/GenVerifyPic": { "post": { "description": "获取验证图片和验证id", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "Auth" ], "summary": "获取验证图片", "parameters": [ { "type": "string", "description": "高", "name": "height", "in": "formData", "required": true }, { "type": "string", "description": "宽", "name": "width", "in": "formData", "required": true }, { "type": "string", "description": "噪点数量", "name": "noiseCount", "in": "formData", "required": true }, { "type": "string", "description": "验证码字数", "name": "length", "in": "formData", "required": true }, { "type": "string", "description": "验证码取值范围 比如 1234567890 或者 abcdef等", "name": "source", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseVerifyPic" } } } } }, "/Auth/GetPhoneVFCode": { "post": { "description": "手机获取验证码", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "Auth" ], "summary": "手机获取验证码", "parameters": [ { "type": "string", "description": "手机号", "name": "phone", "in": "formData", "required": true }, { "type": "integer", "description": "验证码类型 1:登录", "name": "codeType", "in": "formData", "required": true }, { "type": "string", "description": "图形验证码id", "name": "picId", "in": "formData", "required": true }, { "type": "string", "description": "图形验证码", "name": "picCode", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseBase" } } } } }, "/Auth/SignUp": { "post": { "description": "用户添加", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "Auth" ], "summary": "用户添加", "parameters": [ { "type": "string", "description": "用户名", "name": "userCode", "in": "formData", "required": true }, { "type": "string", "description": "密码", "name": "password", "in": "formData", "required": true }, { "type": "string", "description": "邮箱", "name": "email", "in": "formData" }, { "type": "string", "description": "手机号", "name": "phone", "in": "formData" }, { "type": "string", "description": "姓名", "name": "name", "in": "formData" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseBase" } } } } }, "/HrSensors/AddHrSensors": { "post": { "description": "添加商家公共心率设备", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "HrSensors" ], "summary": "添加商家公共心率设备", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "integer", "description": "商家ID", "name": "shopId", "in": "formData", "required": true }, { "type": "integer", "description": "心率带Sn", "name": "sn", "in": "formData", "required": true }, { "type": "string", "description": "场馆内编号 01 02", "name": "venueNo", "in": "formData" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseBase" } } } } }, "/HrSensors/AddPvtHrSensors": { "post": { "description": "添加会员私有心率设备", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "HrSensors" ], "summary": "添加会员私有心率设备", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "integer", "description": "商家ID", "name": "shopId", "in": "formData", "required": true }, { "type": "integer", "description": "心率带Sn", "name": "sn", "in": "formData", "required": true }, { "type": "integer", "description": "用户ID", "name": "userId", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseBase" } } } } }, "/HrSensors/BindHrSensorsToUser": { "post": { "description": "心率带绑定用户", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "HrSensors" ], "summary": "心率带绑定用户", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "string", "description": "心率带Sn", "name": "sn", "in": "formData", "required": true }, { "type": "integer", "description": "课堂记录Id，必传字段", "name": "cfId", "in": "formData", "required": true }, { "type": "integer", "description": "用户Id", "name": "userId", "in": "formData", "required": true }, { "type": "integer", "description": "商家ID", "name": "shopId", "in": "formData", "required": true }, { "type": "integer", "description": "心率带ID", "name": "hrId", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseBase" } } } } }, "/HrSensors/EditHrSensors": { "post": { "description": "修改商家心率设备信息", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "HrSensors" ], "summary": "修改商家心率设备信息", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "integer", "description": "心率带ID", "name": "hrId", "in": "formData", "required": true }, { "type": "string", "description": "心率带Sn", "name": "sn", "in": "formData", "required": true }, { "type": "string", "description": "商家ID", "name": "shopId", "in": "formData", "required": true }, { "type": "string", "description": "场馆内编号 01 02", "name": "venueNo", "in": "formData" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseBase" } } } } }, "/HrSensors/GetHrSensorsPowerPercent": { "post": { "description": "获取心率带电量", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "HrSensors" ], "summary": "获取心率带电量", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "integer", "description": "商家ID", "name": "shopId", "in": "formData", "required": true }, { "type": "integer", "description": "心率带Id", "name": "hrId", "in": "formData" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseBase" } } } } }, "/HrSensors/HrSensorsBindHistory": { "post": { "description": "查询心率带绑定历史记录", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "HrSensors" ], "summary": "查询心率带绑定历史记录", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "integer", "description": "心率带ID", "name": "hrId", "in": "formData" }, { "type": "string", "description": "开始时间 2020-10-10 00:00:01", "name": "bt", "in": "formData", "required": true }, { "type": "string", "description": "结束时间 2020-10-10 23:59:59", "name": "et", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseBase" } } } } }, "/HrSensors/HrSensorsStatusEdit": { "post": { "description": "修改商家心率设备状态", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "HrSensors" ], "summary": "修改商家心率设备状态", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "integer", "description": "心率带ID", "name": "hrId", "in": "formData", "required": true }, { "type": "integer", "description": "状态， 1：启用，8：暂停，9：删除", "name": "status", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseBase" } } } } }, "/HrSensors/QueryHrSensors": { "post": { "description": "查询商家公共心率设备", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "HrSensors" ], "summary": "查询商家公共心率设备", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "integer", "description": "商家ID", "name": "shopId", "in": "formData", "required": true }, { "type": "integer", "description": "设备状态", "name": "status", "in": "formData" }, { "type": "string", "description": "模糊查询sn与场内编号", "name": "str", "in": "formData" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseBase" } } } } }, "/HrSensors/QueryPvtHrSensors": { "post": { "description": "查询商家会员私有心率设备", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "HrSensors" ], "summary": "查询商家会员私有心率设备", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "integer", "description": "商家ID", "name": "shopId", "in": "formData", "required": true }, { "type": "integer", "description": "设备状态", "name": "status", "in": "formData" }, { "type": "string", "description": "用户姓名", "name": "userName", "in": "formData" }, { "type": "string", "description": "模糊查询sn与场内编号", "name": "str", "in": "formData" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseBase" } } } } }, "/HrSensors/SelectHrSensors": { "post": { "description": "查询未绑定的心率带--下拉框用", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "HrSensors" ], "summary": "查询未绑定的心率带--下拉框用", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "integer", "description": "用户ID", "name": "userId", "in": "formData" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseBase" } } } } }, "/HrSensors/UnBindHrSensorsToUser": { "post": { "description": "心率带解绑用户", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "HrSensors" ], "summary": "心率带解绑用户", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "integer", "description": "课堂记录Id，必传字段", "name": "cfId", "in": "formData", "required": true }, { "type": "integer", "description": "绑定ID", "name": "bindId", "in": "formData", "required": true }, { "type": "integer", "description": "用户ID", "name": "userId", "in": "formData", "required": true }, { "type": "string", "description": "心率带Sn", "name": "sn", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseBase" } } } } }, "/Test/UserAdd": { "post": { "description": "会员用户添加", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "Test" ], "summary": "会员用户添加", "parameters": [ { "type": "string", "description": "姓名", "name": "name", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseBase" } } } } }, "/Test/UserListQuery": { "post": { "description": "会员用户查询", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "Test" ], "summary": "会员用户查询", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.UserList" } } } } }, "/User/ShopCoachAdd": { "post": { "description": "商家教练添加", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "User" ], "summary": "商家教练添加", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "integer", "description": "店铺ID", "name": "shopId", "in": "formData", "required": true }, { "type": "string", "description": "登陆用户名也是手机号", "name": "phone", "in": "formData", "required": true }, { "type": "string", "description": "姓名", "name": "name", "in": "formData", "required": true }, { "type": "string", "description": "密码", "name": "pwd", "in": "formData", "required": true }, { "type": "integer", "description": "性别 1：男， 2：女", "name": "sex", "in": "formData", "required": true }, { "type": "string", "description": "备注", "name": "memo", "in": "formData" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseBase" } } } } }, "/User/ShopCoachEdit": { "post": { "description": "商家教练基本信息修改", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "User" ], "summary": "商家教练基本信息修改", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "integer", "description": "教练ID", "name": "ssId", "in": "formData", "required": true }, { "type": "string", "description": "手机号", "name": "phone", "in": "formData" }, { "type": "string", "description": "密码", "name": "pwd", "in": "formData" }, { "type": "string", "description": "姓名", "name": "name", "in": "formData" }, { "type": "string", "description": "备注", "name": "memo", "in": "formData" }, { "type": "integer", "description": "性别 1：男， 2：女", "name": "sex", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseBase" } } } } }, "/User/ShopCoachListQuery": { "post": { "description": "会员用户列表(带分页)", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "User" ], "summary": "会员用户列表(带分页)", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "string", "description": "手机号", "name": "phone", "in": "formData" }, { "type": "string", "description": "姓名", "name": "name", "in": "formData" }, { "type": "string", "description": "当前条", "name": "start", "in": "formData", "required": true }, { "type": "string", "description": "每页条数", "name": "tableMax", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ShopUserInfo" } } } } }, "/User/ShopCoachSimpleQuery": { "post": { "description": "本店会员用户基本信息查询", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "User" ], "summary": "本店会员用户基本信息查询", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "integer", "description": "商家ID", "name": "shopId", "in": "formData" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ShopCoachSimpleInfo" } } } } }, "/User/ShopCoachStatusEdit": { "post": { "description": "商家教练状态修改", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "User" ], "summary": "商家教练状态修改", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "integer", "description": "教练ID", "name": "ssId", "in": "formData", "required": true }, { "type": "integer", "description": "状态 1：启用\t 8：禁用 9：删除", "name": "status", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseBase" } } } } }, "/User/ShopUserAdd": { "post": { "description": "会员用户添加", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "User" ], "summary": "会员用户添加", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "integer", "description": "店铺ID", "name": "shopId", "in": "formData", "required": true }, { "type": "string", "description": "登陆用户名也是手机号", "name": "phone", "in": "formData", "required": true }, { "type": "string", "description": "姓名", "name": "name", "in": "formData", "required": true }, { "type": "integer", "description": "性别 1：男， 2：女", "name": "sex", "in": "formData", "required": true }, { "type": "string", "description": "生日", "name": "birthday", "in": "formData", "required": true }, { "type": "integer", "description": "身高", "name": "height", "in": "formData", "required": true }, { "type": "string", "description": "体重 ", "name": "weight", "in": "formData", "required": true }, { "type": "integer", "description": "静态心率", "name": "staticHr", "in": "formData" }, { "type": "string", "description": "头像", "name": "head", "in": "formData" }, { "type": "string", "description": "备注", "name": "memo", "in": "formData" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseBase" } } } } }, "/User/ShopUserEdit": { "post": { "description": "会员用户基本信息修改", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "User" ], "summary": "会员用户基本信息修改", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "integer", "description": "用户Id", "name": "userId", "in": "formData", "required": true }, { "type": "string", "description": "手机号", "name": "phone", "in": "formData" }, { "type": "string", "description": "姓名", "name": "name", "in": "formData" }, { "type": "string", "description": "备注", "name": "memo", "in": "formData" }, { "type": "string", "description": "生日", "name": "birthday", "in": "formData", "required": true }, { "type": "integer", "description": "身高", "name": "height", "in": "formData", "required": true }, { "type": "string", "description": "体重", "name": "weight", "in": "formData", "required": true }, { "type": "integer", "description": "性别 1：男， 2：女", "name": "sex", "in": "formData", "required": true }, { "type": "integer", "description": "静态心率", "name": "staticHr", "in": "formData" }, { "type": "string", "description": "头像URL", "name": "head", "in": "formData" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseBase" } } } } }, "/User/ShopUserListQuery": { "post": { "description": "会员用户列表(带分页)", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "User" ], "summary": "会员用户列表(带分页)", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "string", "description": "手机号", "name": "phone", "in": "formData" }, { "type": "string", "description": "姓名", "name": "name", "in": "formData" }, { "type": "string", "description": "当前条", "name": "start", "in": "formData", "required": true }, { "type": "string", "description": "每页条数", "name": "tableMax", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ShopUserInfo" } } } } }, "/User/ShopUserSimpleQuery": { "post": { "description": "本店会员用户基本信息查询", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "User" ], "summary": "本店会员用户基本信息查询", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "integer", "description": "商家ID", "name": "shopId", "in": "formData" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ShopUserSimpleInfo" } } } } }, "/User/ShopUserStatusEdit": { "post": { "description": "会员用户状态修改", "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "tags": [ "User" ], "summary": "会员用户状态修改", "parameters": [ { "type": "string", "description": "Token", "name": "token", "in": "formData", "required": true }, { "type": "integer", "description": "用户ID", "name": "userId", "in": "formData", "required": true }, { "type": "integer", "description": "状态 1：启用\t 8：禁用 9：删除", "name": "status", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.ResponseBase" } } } } } }, "definitions": { "controller.ResponseBase": { "type": "object", "properties": { "code": { "type": "integer" }, "memo": { "type": "string" } } }, "controller.ResponseVerifyPic": { "type": "object", "properties": { "id": { "type": "string" }, "pic": { "type": "string" } } }, "controller.ShopCoachSimpleInfo": { "type": "object", "properties": { "code": { "type": "integer" }, "memo": { "type": "string" }, "rs": { "type": "string" } } }, "controller.ShopUserInfo": { "type": "object", "properties": { "code": { "type": "integer" }, "memo": { "type": "string" }, "pageCount": { "type": "integer" }, "rs": { "type": "string" } } }, "controller.ShopUserSimpleInfo": { "type": "object", "properties": { "code": { "type": "integer" }, "memo": { "type": "string" }, "rs": { "type": "string" } } }, "controller.UserList": { "type": "object", "properties": { "code": { "type": "integer" }, "memo": { "type": "string" }, "rs": { "type": "array", "items": { "type": "object" } } } } }, "securityDefinitions": { "ApiKeyAuth": { "type": "apiKey", "name": "Authorization", "in": "header" }, "BasicAuth": { "type": "basic" }, "OAuth2AccessCode": { "type": "oauth2", "flow": "accessCode", "authorizationUrl": "https://example.com/oauth/authorize", "tokenUrl": "https://example.com/oauth/token", "scopes": { "admin": " Grants read and write access to administrative information" } }, "OAuth2Application": { "type": "oauth2", "flow": "application", "tokenUrl": "https://example.com/oauth/token", "scopes": { "admin": " Grants read and write access to administrative information", "write": " Grants write access" } }, "OAuth2Implicit": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://example.com/oauth/authorize", "scopes": { "admin": " Grants read and write access to administrative information", "write": " Grants write access" } }, "OAuth2Password": { "type": "oauth2", "flow": "password", "tokenUrl": "https://example.com/oauth/token", "scopes": { "admin": " Grants read and write access to administrative information", "read": " Grants read access", "write": " Grants write access" } } } }