2 lines
14 KiB
JSON
2 lines
14 KiB
JSON
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"http://localhost:8082","description":"Generated server url"}],"tags":[{"name":"UserAuth","description":"认证管理"},{"name":"Captcha","description":"验证码管理"},{"name":"User","description":"用户管理"},{"name":"Channel","description":"渠道管理"}],"paths":{"/auth/updatePassword":{"post":{"tags":["UserAuth"],"summary":"修改密码","operationId":"updatePassword","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePasswordCmd"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}},"/auth/sso/logout":{"post":{"tags":["UserAuth"],"summary":"登出","operationId":"logout","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}},"/auth/sso/isLogin":{"post":{"tags":["UserAuth"],"summary":"当前是否登录","operationId":"isLogin","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object"}}}}}}},"/auth/sso/getSsoAuthUrl":{"post":{"tags":["UserAuth"],"summary":"返回SSO认证中心登录地址","operationId":"getSsoAuthUrl","parameters":[{"name":"clientLoginUrl","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SingleResponseString"}}}}}}},"/auth/sso/getRedirectUrl":{"post":{"tags":["UserAuth"],"summary":"获取 redirectUrl","operationId":"getRedirectUrl","parameters":[{"name":"redirect","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SingleResponseString"}}}}}}},"/auth/passwordLogin":{"post":{"tags":["UserAuth"],"summary":"账号密码登录接口","operationId":"passwordLogin","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasswordLoginQry"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SingleResponseUserAuthVO"}}}}}}},"/auth/openSafe":{"post":{"tags":["UserAuth"],"summary":"二次认证","operationId":"openSafe","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenSafeCmd"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}},"/auth/captcha/verify":{"post":{"tags":["Captcha"],"operationId":"verify","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaptchaVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}}}},"/auth/captcha/get":{"post":{"tags":["Captcha"],"operationId":"get","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaptchaVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}}}},"/auth/captcha/check":{"post":{"tags":["Captcha"],"operationId":"check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaptchaVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}}}},"/auth/userMenu":{"get":{"tags":["User"],"summary":"菜单列表","operationId":"userMenu","parameters":[{"name":"roleMenuTreeQry","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RoleMenuTreeQry"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MultiResponseTreeLong"}}}}}}},"/auth/userInfo":{"get":{"tags":["User"],"summary":"用户信息","operationId":"userInfo","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SingleResponseUserAuthVO"}}}}}}},"/auth/userAdmin":{"get":{"tags":["User"],"summary":"管理员详情","operationId":"userAdmin","parameters":[{"name":"adminShowQry","in":"query","required":true,"schema":{"$ref":"#/components/schemas/AdminShowQry"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SingleResponseAdminVO"}}}}}}},"/auth/selectChannelByDomain":{"get":{"tags":["Channel"],"summary":"根据域名获取渠道","operationId":"selectChannelByDomain","parameters":[{"name":"domain","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SingleResponseChannelVO"}}}}}}}},"components":{"schemas":{"Response":{"type":"object","properties":{"success":{"type":"boolean"},"errCode":{"type":"string"},"errMessage":{"type":"string"}}},"UpdatePasswordCmd":{"type":"object","properties":{"oldPassword":{"type":"string","title":"旧密码"},"password":{"type":"string","pattern":"^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[@$!%*?&])[A-Za-z\\d@$!%*?&]{8,}$","title":"新密码"},"confirmPassword":{"type":"string","pattern":"^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[@$!%*?&])[A-Za-z\\d@$!%*?&]{8,}$","title":"确认新密码"}},"required":["confirmPassword","oldPassword","password"],"title":"重置密码"},"SingleResponseString":{"type":"object","properties":{"success":{"type":"boolean"},"errCode":{"type":"string"},"errMessage":{"type":"string"},"data":{"type":"string"}}},"PasswordLoginQry":{"type":"object","properties":{"username":{"type":"string","example":18367831980,"maxLength":20,"minLength":4,"pattern":"^[\\w_-]{8,20}$","title":"登录账号"},"password":{"type":"string","example":18367831980,"maxLength":20,"minLength":8,"pattern":"^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[@$!%*?&])[A-Za-z\\d@$!%*?&]{8,}$","title":"登录密码"},"token":{"type":"string","title":"验证码 token"}},"required":["password","username"],"title":"账号密码登录请求"},"Meta":{"type":"object","properties":{"accessToken":{"type":"string","title":"TOKEN"},"tokenType":{"type":"string","title":"TOKEN类型"},"expiresIn":{"type":"integer","format":"int64","title":"过期时间"}},"title":"META扩展"},"PermissionVO":{"type":"object","properties":{"permissionId":{"type":"string","title":"权限Id"},"slug":{"type":"string","title":"权限标识"},"name":{"type":"string","title":"权限名称"}},"required":["name","permissionId","slug"],"title":"权限"},"SingleResponseUserAuthVO":{"type":"object","properties":{"success":{"type":"boolean"},"errCode":{"type":"string"},"errMessage":{"type":"string"},"data":{"$ref":"#/components/schemas/UserAuthVO"}}},"UserAuthVO":{"type":"object","properties":{"userId":{"type":"string","title":"用户编号"},"userVO":{"$ref":"#/components/schemas/UserVO","title":"用户信息"},"userRoleVOList":{"type":"array","items":{"$ref":"#/components/schemas/UserRoleVO"},"title":"用户角色信息"},"permissionVOList":{"type":"array","items":{"$ref":"#/components/schemas/PermissionVO"},"title":"权限信息"},"meta":{"$ref":"#/components/schemas/Meta","title":"META扩展"}},"required":["meta","permissionVOList","userId","userRoleVOList","userVO"],"title":"账号密码注册响应"},"UserRoleVO":{"type":"object","properties":{"name":{"type":"string","title":"角色名称"},"slug":{"type":"string","title":"角色标识"},"roleId":{"type":"string","title":"角色ID"}},"required":["name","roleId","slug"],"title":"用户角色"},"UserVO":{"type":"object","properties":{"userId":{"type":"string","title":"用户编号"},"nickname":{"type":"string","title":"昵称"},"avatar":{"type":"string","title":"头像"},"name":{"type":"string","title":"姓名"},"gender":{"type":"integer","format":"int32","title":"性别"},"birthday":{"type":"string","title":"生日"},"phone":{"type":"string","title":"手机号"},"balance":{"type":"string","title":"余额"},"point":{"type":"integer","format":"int32","title":"积分"},"remark":{"type":"string","title":"备注"},"state":{"type":"string","enum":["ENABLE","DISABLE"],"title":"状态"},"isAdmin":{"type":"boolean","title":"是否是管理员"},"createdAt":{"type":"string","title":"创建时间"},"bindPhoneAt":{"type":"string","title":"绑定手机号码时间"},"lastLoginAt":{"type":"string","title":"最后一次登录时间"},"isBindWechat":{"type":"boolean","title":"是否绑定微信"},"sourceChannel":{"type":"string","enum":["WECHAT","MANAGE_BACKEND","BOSS_END","DOUYIN","INTRODUCE"],"title":"来源渠道"},"sourceWay":{"type":"string","enum":["MANUAL_ENTRY","EXTERNAL_IMPORT","NINE_GRID_LOTTERY","ENTER_COUPON_PAGE","ENTER_HOME_PAGE"],"title":"来源方式"},"customField":{"type":"object","additionalProperties":{},"properties":{"empty":{"type":"boolean"}},"title":"自定义字段"},"lastFollowUpAt":{"type":"string","title":"上次跟进时间"},"userFollowUpDay":{"type":"integer","format":"int32","title":"上次跟进天数"},"isSign":{"type":"boolean","title":"是否签单"},"storeIdList":{"type":"array","items":{"type":"integer","format":"int64"},"title":"门店id"},"spuName":{"type":"string","title":"课程名称"},"useNum":{"type":"integer","format":"int32","title":"课程已参与次数"}},"required":["avatar","balance","bindPhoneAt","birthday","createdAt","customField","gender","isAdmin","isBindWechat","isSign","lastFollowUpAt","lastLoginAt","name","nickname","phone","point","sourceChannel","sourceWay","state","userFollowUpDay","userId"],"title":"用户信息"},"OpenSafeCmd":{"type":"object","properties":{"password":{"type":"string","pattern":"^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[@$!%*?&])[A-Za-z\\d@$!%*?&]{8,}$","title":"登录密码"}},"required":["password"],"title":"管理员创建"},"CaptchaVO":{"type":"object","properties":{"captchaId":{"type":"string"},"projectCode":{"type":"string"},"captchaType":{"type":"string"},"captchaOriginalPath":{"type":"string"},"captchaFontType":{"type":"string"},"captchaFontSize":{"type":"integer","format":"int32"},"secretKey":{"type":"string"},"originalImageBase64":{"type":"string"},"point":{"$ref":"#/components/schemas/PointVO"},"jigsawImageBase64":{"type":"string"},"wordList":{"type":"array","items":{"type":"string"}},"pointList":{"type":"array","items":{"type":"object","properties":{"x":{"type":"number","format":"double"},"y":{"type":"number","format":"double"}}}},"pointJson":{"type":"string"},"token":{"type":"string"},"result":{"type":"boolean"},"captchaVerification":{"type":"string"},"clientUid":{"type":"string"},"ts":{"type":"integer","format":"int64"},"browserInfo":{"type":"string"}}},"PointVO":{"type":"object","properties":{"secretKey":{"type":"string"},"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"}}},"ResponseModel":{"type":"object","properties":{"repCode":{"type":"string"},"repMsg":{"type":"string"},"repData":{},"success":{"type":"boolean"},"repCodeEnum":{"type":"string","enum":["SUCCESS","ERROR","EXCEPTION","BLANK_ERROR","NULL_ERROR","NOT_NULL_ERROR","NOT_EXIST_ERROR","EXIST_ERROR","PARAM_TYPE_ERROR","PARAM_FORMAT_ERROR","API_CAPTCHA_INVALID","API_CAPTCHA_COORDINATE_ERROR","API_CAPTCHA_ERROR","API_CAPTCHA_BASEMAP_NULL","API_REQ_LIMIT_GET_ERROR","API_REQ_INVALID","API_REQ_LOCK_GET_ERROR","API_REQ_LIMIT_CHECK_ERROR","API_REQ_LIMIT_VERIFY_ERROR"],"writeOnly":true}}},"RoleMenuTreeQry":{"type":"object","properties":{"roleId":{"type":"array","example":"acp","items":{"type":"integer","format":"int64"},"title":"角色权限"},"platformId":{"type":"string","title":"平台ID"}},"required":["platformId"],"title":"菜单请求"},"MultiResponseTreeLong":{"type":"object","properties":{"success":{"type":"boolean"},"errCode":{"type":"string"},"errMessage":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TreeLong"}},"empty":{"type":"boolean"},"notEmpty":{"type":"boolean"}}},"TreeLong":{"type":"object","additionalProperties":{},"properties":{"name":{"type":"object","properties":{"empty":{"type":"boolean"}}},"id":{"type":"integer","format":"int64"},"parentId":{"type":"integer","format":"int64"},"config":{"$ref":"#/components/schemas/TreeNodeConfig"},"weight":{},"empty":{"type":"boolean"}}},"TreeNodeConfig":{"type":"object","properties":{"idKey":{"type":"string"},"parentIdKey":{"type":"string"},"weightKey":{"type":"string"},"nameKey":{"type":"string"},"childrenKey":{"type":"string"},"deep":{"type":"integer","format":"int32"}}},"AdminShowQry":{"type":"object","properties":{"adminId":{"type":"string","title":"管理员ID"},"userId":{"type":"string","title":"用户ID"},"type":{"type":"string","title":"管理员类型"}},"title":"管理员查询"},"AdminVO":{"type":"object","properties":{"adminId":{"type":"string","title":"管理员Id"},"name":{"type":"string","title":"管理员名称"},"userId":{"type":"string","title":"用户Id"},"type":{"type":"string","title":"管理员类型"}},"required":["adminId","name","userId"],"title":"管理员"},"SingleResponseAdminVO":{"type":"object","properties":{"success":{"type":"boolean"},"errCode":{"type":"string"},"errMessage":{"type":"string"},"data":{"$ref":"#/components/schemas/AdminVO"}}},"ChannelVO":{"type":"object","properties":{"channelId":{"type":"string","title":"渠道ID"},"domain":{"type":"string","title":"域名"},"logo":{"type":"string","title":"Logo"},"title":{"type":"string","title":"标题"},"subTitle":{"type":"string","title":"副标题"},"backgroundImageUrl":{"type":"string","title":"背景图片"},"technicalSupport":{"type":"string","title":"技术支持"},"createdAt":{"type":"string","format":"date-time","title":"创建时间"},"wxMpId":{"type":"string","title":"微信公众号Id"},"wxOpenId":{"type":"string","title":"第三方应用Id"}},"required":["channelId"],"title":"渠道"},"SingleResponseChannelVO":{"type":"object","properties":{"success":{"type":"boolean"},"errCode":{"type":"string"},"errMessage":{"type":"string"},"data":{"$ref":"#/components/schemas/ChannelVO"}}}}}}
|