1303 lines
34 KiB
JSON
1303 lines
34 KiB
JSON
{
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"schemes": [
|
|
"http",
|
|
"https"
|
|
],
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"description": "Description: app service",
|
|
"title": "app",
|
|
"version": "0.0.1"
|
|
},
|
|
"host": "localhost:0",
|
|
"basePath": "/",
|
|
"paths": {
|
|
"/get/verifyCode": {
|
|
"post": {
|
|
"description": "GetVerifyCode | 获取验证码",
|
|
"tags": [
|
|
"user_public"
|
|
],
|
|
"summary": "GetVerifyCode | 获取验证码",
|
|
"operationId": "GetVerifyCode",
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/VerifyCodeReq"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "VerifyCodeResp",
|
|
"schema": {
|
|
"$ref": "#/definitions/VerifyCodeResp"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/init/database": {
|
|
"get": {
|
|
"description": "Initialize database | 初始化数据库",
|
|
"tags": [
|
|
"base"
|
|
],
|
|
"summary": "Initialize database | 初始化数据库",
|
|
"operationId": "InitDatabase",
|
|
"responses": {
|
|
"200": {
|
|
"description": "BaseMsgResp",
|
|
"schema": {
|
|
"$ref": "#/definitions/BaseMsgResp"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/login": {
|
|
"post": {
|
|
"description": "Login | 登录",
|
|
"tags": [
|
|
"user_public"
|
|
],
|
|
"summary": "Login | 登录",
|
|
"operationId": "Login",
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/LoginReq"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "LoginResp",
|
|
"schema": {
|
|
"$ref": "#/definitions/LoginResp"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/logout": {
|
|
"post": {
|
|
"description": "登出",
|
|
"tags": [
|
|
"user"
|
|
],
|
|
"summary": "登出",
|
|
"operationId": "Logout",
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/IDReq"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "BaseDataInfo",
|
|
"schema": {
|
|
"$ref": "#/definitions/BaseDataInfo"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/register": {
|
|
"post": {
|
|
"description": "Register | 注册",
|
|
"tags": [
|
|
"user_public"
|
|
],
|
|
"summary": "Register | 注册",
|
|
"operationId": "Register",
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/RegisterReq"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "RegisterResp",
|
|
"schema": {
|
|
"$ref": "#/definitions/RegisterResp"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user": {
|
|
"post": {
|
|
"description": "Get userInfo detail by ID | 获取用户信息",
|
|
"tags": [
|
|
"user"
|
|
],
|
|
"summary": "Get userInfo detail by ID | 获取用户信息",
|
|
"operationId": "GetUserInfoById",
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/IDReq"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "UserInfo",
|
|
"schema": {
|
|
"$ref": "#/definitions/UserInfo"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user/checkLogin": {
|
|
"post": {
|
|
"description": "CheckLogin | 检测登录状态",
|
|
"tags": [
|
|
"user"
|
|
],
|
|
"summary": "CheckLogin | 检测登录状态",
|
|
"operationId": "CheckLogin",
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/IDReq"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "BaseDataInfo",
|
|
"schema": {
|
|
"$ref": "#/definitions/BaseDataInfo"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user/info": {
|
|
"post": {
|
|
"description": "@ Get UserInfo detail By Token | 获取用户信息",
|
|
"tags": [
|
|
"user"
|
|
],
|
|
"summary": "@ Get UserInfo detail By Token | 获取用户信息",
|
|
"operationId": "GetUserInfoByToken",
|
|
"responses": {
|
|
"200": {
|
|
"description": "UserInfo",
|
|
"schema": {
|
|
"$ref": "#/definitions/UserInfo"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user/list": {
|
|
"post": {
|
|
"description": "List userInfo | 获取用户列表",
|
|
"tags": [
|
|
"user"
|
|
],
|
|
"summary": "List userInfo | 获取用户列表",
|
|
"operationId": "ListUserInfo",
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/UserListReq"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "UserListResp",
|
|
"schema": {
|
|
"$ref": "#/definitions/UserListResp"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user/oauthAuthorize": {
|
|
"post": {
|
|
"description": "OauthAuthorize | 第三方登录接口",
|
|
"tags": [
|
|
"user"
|
|
],
|
|
"summary": "OauthAuthorize | 第三方登录接口",
|
|
"operationId": "OauthAuthorize",
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/OauthAuthorizeReq"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OauthAuthorizeResp",
|
|
"schema": {
|
|
"$ref": "#/definitions/OauthAuthorizeResp"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user/passWordReset": {
|
|
"post": {
|
|
"description": "PassWordReset | 修改密码",
|
|
"tags": [
|
|
"user"
|
|
],
|
|
"summary": "PassWordReset | 修改密码",
|
|
"operationId": "PassWordReset",
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/PassWordResetReq"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "BaseDataInfo",
|
|
"schema": {
|
|
"$ref": "#/definitions/BaseDataInfo"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user/update": {
|
|
"post": {
|
|
"description": "Update userInfo | 更新用户信息",
|
|
"tags": [
|
|
"user"
|
|
],
|
|
"summary": "Update userInfo | 更新用户信息",
|
|
"operationId": "UpdateUserInfo",
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/UserInfo"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "BaseDataInfo",
|
|
"schema": {
|
|
"$ref": "#/definitions/BaseDataInfo"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"definitions": {
|
|
"AuthToken": {
|
|
"type": "object",
|
|
"properties": {
|
|
"accessToken": {
|
|
"description": "access_token",
|
|
"type": "string",
|
|
"x-go-name": "AccessToken"
|
|
},
|
|
"accessTokenExpires": {
|
|
"description": "access_token_expires",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "AccessTokenExpires"
|
|
},
|
|
"refreshToken": {
|
|
"description": "refresh_token",
|
|
"type": "string",
|
|
"x-go-name": "RefreshToken"
|
|
},
|
|
"refreshTokenExpires": {
|
|
"description": "refresh_token_expires",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "RefreshTokenExpires"
|
|
},
|
|
"tokenType": {
|
|
"description": "token_type 类型",
|
|
"type": "string",
|
|
"x-go-name": "TokenType"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"BaseDataInfo": {
|
|
"description": "The basic response with data | 基础带数据信息",
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"description": "Error code | 错误代码",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "Code"
|
|
},
|
|
"data": {
|
|
"description": "Data | 数据",
|
|
"type": "string",
|
|
"x-go-name": "Data"
|
|
},
|
|
"msg": {
|
|
"description": "Message | 提示信息",
|
|
"type": "string",
|
|
"x-go-name": "Msg"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"BaseIDInfo": {
|
|
"description": "The base ID response data | 基础ID信息",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"description": "Create date | 创建日期",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "CreatedAt"
|
|
},
|
|
"id": {
|
|
"description": "ID",
|
|
"type": "string",
|
|
"format": "uint64",
|
|
"x-go-name": "Id"
|
|
},
|
|
"updatedAt": {
|
|
"description": "Update date | 更新日期",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "UpdatedAt"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"BaseIDInt32Info": {
|
|
"description": "The base ID response data (int32) | 基础ID信息 (int32)",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"description": "Create date | 创建日期",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "CreatedAt"
|
|
},
|
|
"id": {
|
|
"description": "ID",
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"x-go-name": "Id"
|
|
},
|
|
"updatedAt": {
|
|
"description": "Update date | 更新日期",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "UpdatedAt"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"BaseIDInt64Info": {
|
|
"description": "The base ID response data (int64) | 基础ID信息 (int64)",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"description": "Create date | 创建日期",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "CreatedAt"
|
|
},
|
|
"id": {
|
|
"description": "ID",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "Id"
|
|
},
|
|
"updatedAt": {
|
|
"description": "Update date | 更新日期",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "UpdatedAt"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"BaseIDStringInfo": {
|
|
"description": "The base ID response data (string) | 基础ID信息 (string)",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"description": "Create date | 创建日期",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "CreatedAt"
|
|
},
|
|
"id": {
|
|
"description": "ID",
|
|
"type": "string",
|
|
"x-go-name": "Id"
|
|
},
|
|
"updatedAt": {
|
|
"description": "Update date | 更新日期",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "UpdatedAt"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"BaseIDUint32Info": {
|
|
"description": "The base ID response data (uint32) | 基础ID信息 (uint32)",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"description": "Create date | 创建日期",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "CreatedAt"
|
|
},
|
|
"id": {
|
|
"description": "ID",
|
|
"type": "integer",
|
|
"format": "uint32",
|
|
"x-go-name": "Id"
|
|
},
|
|
"updatedAt": {
|
|
"description": "Update date | 更新日期",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "UpdatedAt"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"BaseListInfo": {
|
|
"description": "The basic response with data | 基础带数据信息",
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "Data | 数据",
|
|
"type": "string",
|
|
"x-go-name": "Data"
|
|
},
|
|
"total": {
|
|
"description": "The total number of data | 数据总数",
|
|
"type": "integer",
|
|
"format": "uint64",
|
|
"x-go-name": "Total"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"BaseMsgResp": {
|
|
"description": "The basic response without data | 基础不带数据信息",
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"description": "Error code | 错误代码",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "Code"
|
|
},
|
|
"msg": {
|
|
"description": "Message | 提示信息",
|
|
"type": "string",
|
|
"x-go-name": "Msg"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"BaseUUIDInfo": {
|
|
"description": "The base UUID response data | 基础UUID信息",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"description": "Create date | 创建日期",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "CreatedAt"
|
|
},
|
|
"id": {
|
|
"description": "ID",
|
|
"type": "string",
|
|
"x-go-name": "Id"
|
|
},
|
|
"updatedAt": {
|
|
"description": "Update date | 更新日期",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "UpdatedAt"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"IDInt32PathReq": {
|
|
"description": "Basic ID request (int32) | 基础ID地址参数请求 (int32)",
|
|
"type": "object",
|
|
"required": [
|
|
"Id"
|
|
],
|
|
"properties": {
|
|
"Id": {
|
|
"description": "ID",
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"IDInt32Req": {
|
|
"description": "Basic ID request (int32) | 基础ID参数请求 (int32)",
|
|
"type": "object",
|
|
"required": [
|
|
"id"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"description": "ID",
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"x-go-name": "Id"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"IDInt64PathReq": {
|
|
"description": "Basic ID request (int64) | 基础ID地址参数请求 (int64)",
|
|
"type": "object",
|
|
"required": [
|
|
"Id"
|
|
],
|
|
"properties": {
|
|
"Id": {
|
|
"description": "ID",
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"IDInt64Req": {
|
|
"description": "Basic ID request (int64) | 基础ID参数请求 (int64)",
|
|
"type": "object",
|
|
"required": [
|
|
"id"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"description": "ID",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "Id"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"IDPathReq": {
|
|
"description": "Basic ID request | 基础ID地址参数请求",
|
|
"type": "object",
|
|
"required": [
|
|
"Id"
|
|
],
|
|
"properties": {
|
|
"Id": {
|
|
"description": "ID",
|
|
"type": "integer",
|
|
"format": "uint64"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"IDReq": {
|
|
"description": "Basic ID request | 基础ID参数请求",
|
|
"type": "object",
|
|
"required": [
|
|
"id"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"description": "ID",
|
|
"type": "string",
|
|
"format": "uint64",
|
|
"x-go-name": "Id"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"IDStringPathReq": {
|
|
"description": "Basic ID request (string) | 基础ID地址参数请求 (string)",
|
|
"type": "object",
|
|
"required": [
|
|
"Id"
|
|
],
|
|
"properties": {
|
|
"Id": {
|
|
"description": "ID",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"IDStringReq": {
|
|
"description": "Basic ID request (string) | 基础ID参数请求 (string)",
|
|
"type": "object",
|
|
"required": [
|
|
"id"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"description": "ID",
|
|
"type": "string",
|
|
"x-go-name": "Id"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"IDUint32PathReq": {
|
|
"description": "Basic ID request (uint32) | 基础ID地址参数请求 (uint32)",
|
|
"type": "object",
|
|
"required": [
|
|
"Id"
|
|
],
|
|
"properties": {
|
|
"Id": {
|
|
"description": "ID",
|
|
"type": "integer",
|
|
"format": "uint32"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"IDUint32Req": {
|
|
"description": "Basic ID request (uint32) | 基础ID参数请求 (uint32)",
|
|
"type": "object",
|
|
"required": [
|
|
"id"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"description": "ID",
|
|
"type": "integer",
|
|
"format": "uint32",
|
|
"x-go-name": "Id"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"IDsInt32Req": {
|
|
"description": "Basic IDs request (int32) | 基础ID数组参数请求 (int32)",
|
|
"type": "object",
|
|
"required": [
|
|
"ids"
|
|
],
|
|
"properties": {
|
|
"ids": {
|
|
"description": "IDs",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"x-go-name": "Ids"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"IDsInt64Req": {
|
|
"description": "Basic IDs request (int64) | 基础ID数组参数请求 (int64)",
|
|
"type": "object",
|
|
"required": [
|
|
"ids"
|
|
],
|
|
"properties": {
|
|
"ids": {
|
|
"description": "IDs",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"x-go-name": "Ids"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"IDsReq": {
|
|
"description": "Basic IDs request | 基础ID数组参数请求",
|
|
"type": "object",
|
|
"required": [
|
|
"ids"
|
|
],
|
|
"properties": {
|
|
"ids": {
|
|
"description": "IDs",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "uint64"
|
|
},
|
|
"x-go-name": "Ids"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"IDsStringReq": {
|
|
"description": "Basic IDs request (string) | 基础ID数组参数请求 (string)",
|
|
"type": "object",
|
|
"required": [
|
|
"ids"
|
|
],
|
|
"properties": {
|
|
"ids": {
|
|
"description": "IDs",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"x-go-name": "Ids"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"IDsUint32Req": {
|
|
"description": "Basic IDs request (uint32) | 基础ID数组参数请求 (uint32)",
|
|
"type": "object",
|
|
"required": [
|
|
"ids"
|
|
],
|
|
"properties": {
|
|
"ids": {
|
|
"description": "IDs",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "uint32"
|
|
},
|
|
"x-go-name": "Ids"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"LoginReq": {
|
|
"type": "object",
|
|
"properties": {
|
|
"clientIp": {
|
|
"description": "ClientIP",
|
|
"type": "string",
|
|
"x-go-name": "ClientIP"
|
|
},
|
|
"loginPlatform": {
|
|
"description": "登录系统",
|
|
"type": "string",
|
|
"x-go-name": "LoginPlatform"
|
|
},
|
|
"loginType": {
|
|
"description": "登录方式",
|
|
"type": "string",
|
|
"x-go-name": "LoginType"
|
|
},
|
|
"password": {
|
|
"description": "Password",
|
|
"type": "string",
|
|
"x-go-name": "Password"
|
|
},
|
|
"userName": {
|
|
"description": "UserName or Email or Mobile",
|
|
"type": "string",
|
|
"x-go-name": "UserName"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"LoginResp": {
|
|
"type": "object",
|
|
"properties": {
|
|
"AuthToken": {
|
|
"$ref": "#/definitions/AuthToken"
|
|
},
|
|
"UserInfo": {
|
|
"$ref": "#/definitions/UserInfo"
|
|
},
|
|
"code": {
|
|
"description": "Error code | 错误代码",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "Code"
|
|
},
|
|
"msg": {
|
|
"description": "Message | 提示信息",
|
|
"type": "string",
|
|
"x-go-name": "Msg"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"OauthAuthorizeReq": {
|
|
"type": "object",
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"OauthAuthorizeResp": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"description": "Error code | 错误代码",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "Code"
|
|
},
|
|
"msg": {
|
|
"description": "Message | 提示信息",
|
|
"type": "string",
|
|
"x-go-name": "Msg"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"PageInfo": {
|
|
"description": "The page request parameters | 列表请求参数",
|
|
"type": "object",
|
|
"required": [
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"properties": {
|
|
"page": {
|
|
"description": "Page number | 第几页",
|
|
"type": "integer",
|
|
"format": "uint64",
|
|
"minimum": 0,
|
|
"x-go-name": "Page"
|
|
},
|
|
"pageSize": {
|
|
"description": "Page size | 单页数据行数",
|
|
"type": "integer",
|
|
"format": "uint64",
|
|
"maximum": 100000,
|
|
"x-go-name": "PageSize"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"PassWordResetReq": {
|
|
"type": "object",
|
|
"properties": {
|
|
"password": {
|
|
"description": "Password",
|
|
"type": "string",
|
|
"x-go-name": "Password"
|
|
},
|
|
"userName": {
|
|
"description": "UserName or Email or Mobile",
|
|
"type": "string",
|
|
"x-go-name": "UserName"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"RegisterReq": {
|
|
"type": "object",
|
|
"properties": {
|
|
"accountType": {
|
|
"description": "账户注册类型:手机或邮箱",
|
|
"type": "integer",
|
|
"format": "uint8",
|
|
"x-go-name": "AccountType"
|
|
},
|
|
"birthday": {
|
|
"description": "生日",
|
|
"type": "integer",
|
|
"format": "uint32",
|
|
"x-go-name": "Birthday"
|
|
},
|
|
"captcha": {
|
|
"description": "验证码",
|
|
"type": "string",
|
|
"x-go-name": "Captcha"
|
|
},
|
|
"captchaId": {
|
|
"description": "验证码ID",
|
|
"type": "string",
|
|
"x-go-name": "CaptchaId"
|
|
},
|
|
"gender": {
|
|
"description": "Gender male or female or other , 男,女,其他",
|
|
"type": "string",
|
|
"x-go-name": "Gender"
|
|
},
|
|
"nickName": {
|
|
"description": "昵称",
|
|
"type": "string",
|
|
"x-go-name": "NickName"
|
|
},
|
|
"passwordHash": {
|
|
"description": "密码加密后的值",
|
|
"type": "string",
|
|
"x-go-name": "PasswordHash"
|
|
},
|
|
"registerSource": {
|
|
"description": "注册来源 app,pc",
|
|
"type": "string",
|
|
"x-go-name": "RegisterSource"
|
|
},
|
|
"sex": {
|
|
"description": "性别",
|
|
"type": "integer",
|
|
"format": "uint8",
|
|
"x-go-name": "Sex"
|
|
},
|
|
"value": {
|
|
"description": "手机号或邮箱地址注册",
|
|
"type": "string",
|
|
"x-go-name": "Value"
|
|
},
|
|
"verificationType": {
|
|
"description": "VerificationType 类型 1 手机 2 邮箱",
|
|
"type": "integer",
|
|
"format": "uint32",
|
|
"x-go-name": "VerificationType"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"RegisterResp": {
|
|
"type": "object",
|
|
"properties": {
|
|
"authToken": {
|
|
"$ref": "#/definitions/AuthToken"
|
|
},
|
|
"userInfo": {
|
|
"$ref": "#/definitions/UserInfo"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"UUIDPathReq": {
|
|
"description": "Basic UUID request in path | 基础UUID地址参数请求",
|
|
"type": "object",
|
|
"required": [
|
|
"Id"
|
|
],
|
|
"properties": {
|
|
"Id": {
|
|
"description": "ID",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"UUIDReq": {
|
|
"description": "Basic UUID request | 基础UUID参数请求",
|
|
"type": "object",
|
|
"required": [
|
|
"id"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"description": "ID",
|
|
"type": "string",
|
|
"maxLength": 36,
|
|
"minLength": 36,
|
|
"x-go-name": "Id"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"UUIDsReq": {
|
|
"description": "Basic UUID array request | 基础UUID数组参数请求",
|
|
"type": "object",
|
|
"required": [
|
|
"ids"
|
|
],
|
|
"properties": {
|
|
"ids": {
|
|
"description": "Ids",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"x-go-name": "Ids"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"UserInfo": {
|
|
"type": "object",
|
|
"properties": {
|
|
"avatar": {
|
|
"description": "头像",
|
|
"type": "string",
|
|
"x-go-name": "Avatar"
|
|
},
|
|
"birthday": {
|
|
"description": "生日",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "Birthday"
|
|
},
|
|
"createdAt": {
|
|
"description": "Create date | 创建日期",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "CreatedAt"
|
|
},
|
|
"email": {
|
|
"description": "邮箱",
|
|
"type": "string",
|
|
"x-go-name": "Email"
|
|
},
|
|
"gender": {
|
|
"description": "Gender male or female or other , 男,女,其他",
|
|
"type": "string",
|
|
"x-go-name": "Gender"
|
|
},
|
|
"id": {
|
|
"description": "ID",
|
|
"type": "string",
|
|
"format": "uint64",
|
|
"x-go-name": "Id"
|
|
},
|
|
"mobile": {
|
|
"description": "手机号",
|
|
"type": "string",
|
|
"x-go-name": "Mobile"
|
|
},
|
|
"nickName": {
|
|
"description": "昵称",
|
|
"type": "string",
|
|
"x-go-name": "NickName"
|
|
},
|
|
"registerType": {
|
|
"description": "账户注册类型:\n1 手机 2 邮箱",
|
|
"type": "integer",
|
|
"format": "uint32",
|
|
"x-go-name": "RegisterType"
|
|
},
|
|
"updatedAt": {
|
|
"description": "Update date | 更新日期",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "UpdatedAt"
|
|
},
|
|
"username": {
|
|
"description": "用户名",
|
|
"type": "string",
|
|
"x-go-name": "Username"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"UserInfoResp": {
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"description": "Create date | 创建日期",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "CreatedAt"
|
|
},
|
|
"data": {
|
|
"$ref": "#/definitions/UserInfo"
|
|
},
|
|
"id": {
|
|
"description": "ID",
|
|
"type": "string",
|
|
"format": "uint64",
|
|
"x-go-name": "Id"
|
|
},
|
|
"updatedAt": {
|
|
"description": "Update date | 更新日期",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "UpdatedAt"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"UserListInfo": {
|
|
"description": "The device list data | User信息列表数据",
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"description": "The device list data | User信息列表数据",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/UserInfo"
|
|
},
|
|
"x-go-name": "Data"
|
|
},
|
|
"total": {
|
|
"description": "The total number of data | 数据总数",
|
|
"type": "integer",
|
|
"format": "uint64",
|
|
"x-go-name": "Total"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"UserListReq": {
|
|
"type": "object",
|
|
"required": [
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"properties": {
|
|
"email": {
|
|
"description": "Email or Mobile",
|
|
"type": "string",
|
|
"x-go-name": "Email"
|
|
},
|
|
"mobile": {
|
|
"description": "Mobile",
|
|
"type": "string",
|
|
"x-go-name": "Mobile"
|
|
},
|
|
"page": {
|
|
"description": "Page number | 第几页",
|
|
"type": "integer",
|
|
"format": "uint64",
|
|
"minimum": 0,
|
|
"x-go-name": "Page"
|
|
},
|
|
"pageSize": {
|
|
"description": "Page size | 单页数据行数",
|
|
"type": "integer",
|
|
"format": "uint64",
|
|
"maximum": 100000,
|
|
"x-go-name": "PageSize"
|
|
},
|
|
"status": {
|
|
"description": "Status 1: normal 2: ban | 状态 1 正常 2 禁用",
|
|
"type": "string",
|
|
"x-go-name": "Status"
|
|
},
|
|
"userName": {
|
|
"description": "UserName or Email or Mobile",
|
|
"type": "string",
|
|
"x-go-name": "UserName"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"UserListResp": {
|
|
"description": "The response data of user list | User信息列表数据",
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"description": "Error code | 错误代码",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"x-go-name": "Code"
|
|
},
|
|
"data": {
|
|
"description": "Data | 数据",
|
|
"type": "string",
|
|
"x-go-name": "Data",
|
|
"$ref": "#/definitions/UserListInfo"
|
|
},
|
|
"msg": {
|
|
"description": "Message | 提示信息",
|
|
"type": "string",
|
|
"x-go-name": "Msg"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"VerifyCodeReq": {
|
|
"type": "object",
|
|
"properties": {
|
|
"accountType": {
|
|
"description": "账户注册类型:手机或邮箱",
|
|
"type": "integer",
|
|
"format": "uint8",
|
|
"x-go-name": "AccountType"
|
|
},
|
|
"value": {
|
|
"description": "手机号或邮箱地址",
|
|
"type": "string",
|
|
"x-go-name": "Value"
|
|
},
|
|
"verifyCodeType": {
|
|
"description": "验证码类型",
|
|
"type": "integer",
|
|
"format": "uint8",
|
|
"x-go-name": "VerifyCodeType"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
},
|
|
"VerifyCodeResp": {
|
|
"type": "object",
|
|
"properties": {
|
|
"captchaCode": {
|
|
"description": "验证码",
|
|
"type": "string",
|
|
"x-go-name": "CaptchaCode"
|
|
},
|
|
"expireTime": {
|
|
"description": "过期时间",
|
|
"type": "integer",
|
|
"format": "uint32",
|
|
"x-go-name": "ExpireTime"
|
|
}
|
|
},
|
|
"x-go-package": "mingyang-admin-app-api/internal/types"
|
|
}
|
|
},
|
|
"securityDefinitions": {
|
|
"Token": {
|
|
"type": "apiKey",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"Token": []
|
|
}
|
|
]
|
|
} |