1 line
17 KiB
JSON
1 line
17 KiB
JSON
{"openapi":"3.0.1","info":{"title":"用户中心接口文档","description":"UserBase 用户中心 OpenAPI 文档（springdoc-openapi）","version":"0.0.1"},"servers":[{"url":"http://localhost:8060","description":"Generated server url"}],"paths":{"/oapi/user/transferToSchool":{"post":{"tags":["user-controller"],"operationId":"transferToSchool","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SysUserTransferSchoolRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BoaUser"}}}}}}},"/oapi/user/password":{"post":{"tags":["user-controller"],"operationId":"password","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SysUserPasswordRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}}},"/oapi/user/moveToGroup":{"post":{"tags":["user-controller"],"operationId":"moveToGroup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SysUserMoveRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BoaUser"}}}}}}},"/oapi/user/groupState":{"get":{"tags":["user-controller"],"operationId":"groupState_1","parameters":[{"name":"userId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"groupId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"schoolId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"integer","format":"int32"}}}}}},"post":{"tags":["user-controller"],"operationId":"groupState","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SysUserGroupStateRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}}},"/oapi/user/edit/{id}":{"post":{"tags":["user-controller"],"operationId":"edit","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SysUserRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BoaUser"}}}}}}},"/oapi/user/deleteUsers":{"post":{"tags":["user-controller"],"operationId":"deleteUsers","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SysUserGroupDeleteItem"}}}},"required":true},"responses":{"200":{"description":"OK"}}}},"/oapi/user/delete/{id}/{groupId}/{schoolId}":{"post":{"tags":["user-controller"],"operationId":"delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"groupId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"schoolId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK"}}}},"/oapi/user/changeStatus":{"post":{"tags":["user-controller"],"operationId":"changeStatus","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SysUserChangeStatusRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}}},"/oapi/user/batchChangeStatus":{"post":{"tags":["user-controller"],"operationId":"batchChangeStatus","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchChangeStatusRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}}},"/oapi/user/batchAdd":{"post":{"tags":["user-controller"],"operationId":"batchAdd","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SysUserRequest"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BoaUser"}}}}}}}},"/oapi/user/add":{"post":{"tags":["user-controller"],"operationId":"add","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SysUserRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BoaUser"}}}}}}},"/oapi/identity/switch":{"post":{"tags":["identity-controller"],"operationId":"switchIdentity","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentitySwitchOapiRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BoaRoleInfo"}}}}}}},"/oapi/group/move/{schoolId}":{"post":{"tags":["group-controller"],"operationId":"move","parameters":[{"name":"schoolId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SysGroupMoveRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}}},"/oapi/group/edit/{id}":{"post":{"tags":["group-controller"],"operationId":"edit_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SysGroupRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BoaGroup"}}}}}}},"/oapi/group/delete/{id}/{schoolId}":{"post":{"tags":["group-controller"],"operationId":"delete_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"schoolId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK"}}}},"/oapi/group/batchAdd":{"post":{"tags":["group-controller"],"operationId":"batchAdd_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SysGroupBatchRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BoaGroup"}}}}}}}},"/oapi/group/add":{"post":{"tags":["group-controller"],"operationId":"add_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SysGroupRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BoaGroup"}}}}}}},"/oapi/user/roles":{"get":{"tags":["user-controller"],"operationId":"roles","parameters":[{"name":"userId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BoaRoleInfo"}}}}}}}},"/oapi/user/modules":{"get":{"tags":["user-controller"],"operationId":"modules","parameters":[{"name":"userId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"schId","in":"query","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BoaModule"}}}}}}}},"/oapi/user/byPhone":{"get":{"tags":["user-controller"],"operationId":"byPhone","parameters":[{"name":"phone","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BoaUser"}}}}}}},"/oapi/user/byLoginName":{"get":{"tags":["user-controller"],"operationId":"byLoginName","parameters":[{"name":"loginName","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BoaUser"}}}}}}},"/oapi/user/byId":{"get":{"tags":["user-controller"],"operationId":"byId","parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BoaUser"}}}}}}},"/oapi/identity/current":{"get":{"tags":["identity-controller"],"operationId":"current","parameters":[{"name":"userId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BoaRoleInfo"}}}}}}},"/oapi/identity/available":{"get":{"tags":["identity-controller"],"operationId":"available","parameters":[{"name":"userId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BoaRoleInfo"}}}}}}}},"/oapi/group/tree":{"get":{"tags":["group-controller"],"operationId":"tree","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BoaGroup"}}}}}}},"/oapi/group/list":{"get":{"tags":["group-controller"],"operationId":"list","parameters":[{"name":"ids","in":"query","required":true,"schema":{"type":"string"}},{"name":"withSub","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BoaGroup"}}}}}}}},"/oapi/group/byId":{"get":{"tags":["group-controller"],"operationId":"byId_1","parameters":[{"name":"groupId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"withSub","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BoaGroup"}}}}}}},"/oapi/app/{appId}":{"get":{"tags":["app-controller"],"operationId":"byId_2","parameters":[{"name":"appId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApplicationInfoVo"}}}}}}},"/oapi/app/list":{"get":{"tags":["app-controller"],"operationId":"list_1","parameters":[{"name":"userId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"clientType","in":"query","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BoaAppType"}}}}}}}}},"components":{"schemas":{"SysUserTransferSchoolRequest":{"required":["fromSchoolId","groupId","schoolId","userId"],"type":"object","properties":{"userId":{"type":"integer","format":"int32"},"fromSchoolId":{"type":"integer","format":"int32"},"schoolId":{"type":"integer","format":"int32"},"groupId":{"type":"integer","format":"int32"}}},"BoaGroup":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"parentId":{"type":"integer","format":"int32"},"type":{"type":"integer","format":"int32"},"sort":{"type":"integer","format":"int32"},"children":{"type":"array","items":{"$ref":"#/components/schemas/BoaGroup"}}}},"BoaRoleInfo":{"type":"object","properties":{"roleId":{"type":"integer","format":"int32"},"roleName":{"type":"string"},"schId":{"type":"integer","format":"int32"},"schName":{"type":"string"},"childId":{"type":"integer","format":"int32"},"childName":{"type":"string"}}},"BoaUser":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"account":{"type":"string"},"name":{"type":"string"},"idcard":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"},"gender":{"type":"integer","format":"int32"},"profilePicture":{"type":"string"},"type":{"type":"integer","format":"int32"},"status":{"type":"integer","format":"int32"},"dept":{"$ref":"#/components/schemas/BoaGroup"},"school":{"$ref":"#/components/schemas/BoaGroup"},"bureau":{"$ref":"#/components/schemas/BoaGroup"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/BoaGroup"}},"roleIds":{"type":"array","items":{"type":"integer","format":"int32"}},"currentRole":{"$ref":"#/components/schemas/BoaRoleInfo"},"schools":{"type":"array","items":{"$ref":"#/components/schemas/BoaGroup"}}}},"SysUserPasswordRequest":{"required":["newPassword","oldPassword","userId"],"type":"object","properties":{"userId":{"type":"integer","format":"int32"},"oldPassword":{"type":"string"},"newPassword":{"type":"string"}}},"SysUserMoveRequest":{"required":["groupId","schoolId","userId"],"type":"object","properties":{"userId":{"type":"integer","format":"int32"},"groupId":{"type":"integer","format":"int32"},"schoolId":{"type":"integer","format":"int32"}}},"SysUserGroupStateRequest":{"required":["groupId","schoolId","state","userId"],"type":"object","properties":{"userId":{"type":"integer","format":"int32"},"groupId":{"type":"integer","format":"int32"},"schoolId":{"type":"integer","format":"int32"},"state":{"type":"integer","format":"int32"}}},"SysUserRequest":{"required":["account","groupId","id","password"],"type":"object","properties":{"id":{"type":"integer","format":"int32"},"groupId":{"type":"integer","format":"int32"},"account":{"type":"string"},"password":{"type":"string"},"confirmPassword":{"type":"string"},"realName":{"type":"string"},"phone":{"type":"string"},"birthday":{"type":"string","format":"date"},"idcard":{"type":"string"},"email":{"type":"string"},"gender":{"type":"integer","format":"int32"},"profilePicture":{"type":"string"},"schoolId":{"type":"integer","format":"int32"},"roleIds":{"type":"array","items":{"type":"integer","format":"int32"}},"disabled":{"type":"integer","format":"int32"},"expired":{"type":"boolean"}}},"SysUserGroupDeleteItem":{"type":"object","properties":{"userId":{"type":"integer","format":"int32"},"groupId":{"type":"integer","format":"int32"},"schoolId":{"type":"integer","format":"int32"}}},"SysUserChangeStatusRequest":{"required":["disabled","userId"],"type":"object","properties":{"userId":{"type":"integer","format":"int32"},"disabled":{"type":"boolean"}}},"BatchChangeStatusRequest":{"required":["disabled","userIds"],"type":"object","properties":{"userIds":{"type":"array","items":{"type":"integer","format":"int32"}},"disabled":{"type":"boolean"}}},"IdentitySwitchOapiRequest":{"required":["roleId","schoolId","userId"],"type":"object","properties":{"userId":{"type":"integer","format":"int32"},"roleId":{"type":"integer","format":"int32"},"schoolId":{"type":"integer","format":"int32"}}},"SysGroupMoveRequest":{"required":["moveId","pid"],"type":"object","properties":{"moveId":{"type":"integer","format":"int32"},"pid":{"type":"integer","format":"int32"}}},"SysGroupRequest":{"required":["name","parentId","type"],"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"parentId":{"type":"integer","format":"int32"},"type":{"type":"integer","format":"int32"},"sort":{"type":"integer","format":"int32"}}},"BatchItem":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}}},"SysGroupBatchRequest":{"required":["items","pid","type"],"type":"object","properties":{"pid":{"type":"integer","format":"int32"},"type":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/BatchItem"}}}},"BoaModule":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"parentId":{"type":"integer","format":"int32"},"customId":{"type":"string"},"name":{"type":"string"},"path":{"type":"string"},"level":{"type":"integer","format":"int32"},"sortNo":{"type":"integer","format":"int32"},"icon":{"type":"string"}}},"ApplicationInfoVo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"categoryId":{"type":"integer","format":"int32"},"sortNo":{"type":"integer","format":"int32"},"desc":{"type":"string"},"appKey":{"type":"integer","format":"int32"},"appSecret":{"type":"string"},"clients":{"type":"array","items":{"type":"integer","format":"int32"}},"pcUrl":{"type":"string"},"pcIcon":{"type":"string"},"appUrl":{"type":"string"},"appIcon":{"type":"string"},"officialAccountUrl":{"type":"string"},"dingtalkUrl":{"type":"string"}}},"BoaApp":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"icon":{"type":"string"},"version":{"type":"string"},"type":{"type":"integer","format":"int32"},"webAddr":{"type":"string"},"adminAddress":{"type":"string"},"apiRoot":{"type":"string"},"appKey":{"type":"integer","format":"int32"},"orderNumber":{"type":"integer","format":"int32"},"createUser":{"type":"integer","format":"int32"},"createTime":{"type":"string","format":"date-time"},"mobiIcon":{"type":"string"},"clients":{"type":"integer","format":"int32"},"integMode":{"type":"integer","format":"int32"},"builtInTag":{"type":"integer","format":"int32"},"webPagePkgAddr":{"type":"string"},"webAddress":{"type":"string"},"wxgzhAddress":{"type":"string"},"dingAddress":{"type":"string"},"isPublic":{"type":"boolean"},"modules":{"type":"array","items":{"$ref":"#/components/schemas/BoaModule"}}}},"BoaAppType":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"apps":{"type":"array","items":{"$ref":"#/components/schemas/BoaApp"}}}}}}} |