1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062 |
- {
- "swagger": "2.0",
- "info": {
- "description": "This is a sample server celler server.",
- "title": "Swagger Example API",
- "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"
- },
- "host": "localhost:8080",
- "basePath": "/v1/api",
- "paths": {
- "/v1/api/admin/login": {
- "post": {
- "description": "登录API",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "Common"
- ],
- "summary": "登录",
- "parameters": [
- {
- "description": "请求body",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/admin_common.Request"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "allOf": [
- {
- "$ref": "#/definitions/response.ApiResponse"
- },
- {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/definitions/common.UserInfo"
- }
- }
- }
- ]
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- }
- },
- "/v1/api/admin/permission": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "Permissions"
- ],
- "summary": "新增权限",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- },
- {
- "description": "请求body",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/permission.CreateRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- }
- },
- "/v1/api/admin/permission/{permissionID}": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "Permissions"
- ],
- "summary": "获取权限详情",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- },
- {
- "type": "integer",
- "description": "权限ID",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "allOf": [
- {
- "$ref": "#/definitions/response.ApiResponse"
- },
- {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/definitions/admin.AdminPermission"
- }
- }
- }
- ]
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- },
- "put": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "Permissions"
- ],
- "summary": "更新权限",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- },
- {
- "type": "integer",
- "description": "权限ID",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "description": "请求body",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/permission.UpdateRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- },
- "delete": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "Permissions"
- ],
- "summary": "删除权限",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- },
- {
- "type": "integer",
- "description": "权限ID",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- }
- },
- "/v1/api/admin/permission/{permissionID}/toggle": {
- "put": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "Permissions"
- ],
- "summary": "启用/禁用",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- },
- {
- "description": "请求body",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/permission.ToggleRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- }
- },
- "/v1/api/admin/permissions": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "Permissions"
- ],
- "summary": "权限列表",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- },
- {
- "type": "integer",
- "description": "页码",
- "name": "page",
- "in": "query",
- "required": true
- },
- {
- "type": "integer",
- "description": "每页数量",
- "name": "page_size",
- "in": "query",
- "required": true
- },
- {
- "type": "string",
- "description": "关键字",
- "name": "keyword",
- "in": "query"
- },
- {
- "enum": [
- "enabled",
- "disabled"
- ],
- "type": "string",
- "description": "状态",
- "name": "status",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "allOf": [
- {
- "$ref": "#/definitions/response.ApiResponse"
- },
- {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/definitions/permission.ListResponse"
- }
- }
- }
- ]
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- }
- },
- "/v1/api/admin/profile": {
- "get": {
- "description": "查询个人信息",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "Common"
- ],
- "summary": "获取个人信息",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "allOf": [
- {
- "$ref": "#/definitions/response.ApiResponse"
- },
- {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/definitions/common.UserInfo"
- }
- }
- }
- ]
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "Common"
- ],
- "summary": "退出登录",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- }
- },
- "/v1/api/admin/role": {
- "post": {
- "description": "创建角色",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "Role 角色管理"
- ],
- "summary": "新增角色",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- },
- {
- "description": "请求body",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/admin_role.CreateAdminRoleRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- }
- },
- "/v1/api/admin/role/labels": {
- "get": {
- "description": "获取所有已启用角色列表",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "Role 角色管理"
- ],
- "summary": "已启用角色列表",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "allOf": [
- {
- "$ref": "#/definitions/response.ApiResponse"
- },
- {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/definitions/admin_role.EnabledRoles"
- }
- }
- }
- ]
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- }
- },
- "/v1/api/admin/role/{roleID}": {
- "get": {
- "description": "获取角色详情",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "Role 角色管理"
- ],
- "summary": "详情",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- },
- {
- "type": "integer",
- "description": "角色ID",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "allOf": [
- {
- "$ref": "#/definitions/response.ApiResponse"
- },
- {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/definitions/admin.RoleItem"
- }
- }
- }
- ]
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- },
- "put": {
- "description": "更新角色内容",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "Role 角色管理"
- ],
- "summary": "更新角色",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- },
- {
- "type": "integer",
- "description": "角色ID",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "description": "请求body",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/admin_role.UpdateRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- },
- "delete": {
- "description": "删除角色",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "Role 角色管理"
- ],
- "summary": "删除",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- },
- {
- "type": "integer",
- "description": "角色ID",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- }
- },
- "/v1/api/admin/role/{roleID}/toggle": {
- "put": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "Role 角色管理"
- ],
- "summary": "启用/禁用",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- },
- {
- "description": "请求body",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/admin_role.ToggleRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- }
- },
- "/v1/api/admin/roles": {
- "get": {
- "description": "获取角色列表",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "Role 角色管理"
- ],
- "summary": "角色列表",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- },
- {
- "type": "integer",
- "description": "页码",
- "name": "page",
- "in": "query",
- "required": true
- },
- {
- "type": "integer",
- "description": "每页数量",
- "name": "page_size",
- "in": "query",
- "required": true
- },
- {
- "type": "string",
- "description": "关键字",
- "name": "keyword",
- "in": "query"
- },
- {
- "enum": [
- "enabled",
- "disabled"
- ],
- "type": "string",
- "description": "状态",
- "name": "status",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "allOf": [
- {
- "$ref": "#/definitions/response.ApiResponse"
- },
- {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/definitions/admin_role.ListAdminRolesResponse"
- }
- }
- }
- ]
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- }
- },
- "/v1/api/admin/user": {
- "post": {
- "description": "创建用户",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "User 用户管理"
- ],
- "summary": "新增用户",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- },
- {
- "description": "请求body",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/admin_user.UserRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- }
- },
- "/v1/api/admin/user/labels": {
- "get": {
- "description": "获取所有已启用 用户列表",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "User 用户管理"
- ],
- "summary": "已启用 用户列表",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "allOf": [
- {
- "$ref": "#/definitions/response.ApiResponse"
- },
- {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/admin_user.EnabledUserItem"
- }
- }
- }
- }
- ]
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- }
- },
- "/v1/api/admin/user/{id}": {
- "get": {
- "description": "获取用户详情",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "User 用户管理"
- ],
- "summary": "详情",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- },
- {
- "type": "integer",
- "description": "角色ID",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "allOf": [
- {
- "$ref": "#/definitions/response.ApiResponse"
- },
- {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/definitions/authorization_client.GetAdminUser"
- }
- }
- }
- ]
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- }
- },
- "/v1/api/admin/user/{userID}": {
- "put": {
- "description": "更新用户内容",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "User 用户管理"
- ],
- "summary": "修改个人信息",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- },
- {
- "type": "integer",
- "description": "角色ID",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "description": "请求body",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/admin_user.UpdateRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- },
- "delete": {
- "description": "删除管理员",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "User 用户管理"
- ],
- "summary": "删除",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- },
- {
- "type": "integer",
- "description": "用户ID",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- }
- },
- "/v1/api/admin/user/{userID}/toggle": {
- "put": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "User 用户管理"
- ],
- "summary": "启用/禁用",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- },
- {
- "description": "请求body",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/admin_user.ToggleRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- }
- },
- "/v1/api/admin/users": {
- "get": {
- "description": "获取用户列表",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "User 用户管理"
- ],
- "summary": "用户列表",
- "parameters": [
- {
- "type": "string",
- "description": "Bearer 用户令牌",
- "name": "Authorization",
- "in": "header",
- "required": true
- },
- {
- "type": "integer",
- "description": "页码",
- "name": "page",
- "in": "query",
- "required": true
- },
- {
- "type": "integer",
- "description": "每页数量",
- "name": "page_size",
- "in": "query",
- "required": true
- },
- {
- "type": "string",
- "description": "关键字",
- "name": "keyword",
- "in": "query"
- },
- {
- "enum": [
- "enabled",
- "disabled"
- ],
- "type": "string",
- "description": "状态",
- "name": "status",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "成功",
- "schema": {
- "allOf": [
- {
- "$ref": "#/definitions/response.ApiResponse"
- },
- {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "#/definitions/admin_user.ListAdminUserResponse"
- }
- }
- }
- ]
- }
- },
- "400": {
- "description": "请求错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- },
- "500": {
- "description": "内部错误",
- "schema": {
- "$ref": "#/definitions/response.ApiResponse"
- }
- }
- }
- }
- }
- },
- "definitions": {
- "admin.AdminPermission": {
- "type": "object",
- "properties": {
- "created_at": {
- "type": "string"
- },
- "created_by": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "endpoint": {
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "is_reserved": {
- "type": "boolean"
- },
- "name": {
- "type": "string"
- },
- "roles": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/base.ListMapItem"
- }
- },
- "status": {
- "description": "可以是 \"enabled\", \"disabled\", \"deleted\" 等",
- "type": "string"
- },
- "updated_at": {
- "type": "string"
- },
- "updated_by": {
- "type": "string"
- }
- }
- },
- "admin.RoleItem": {
- "type": "object",
- "properties": {
- "created_at": {
- "description": "创建时间",
- "type": "string"
- },
- "created_by": {
- "description": "创建人",
- "type": "string"
- },
- "description": {
- "description": "描述",
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "is_reserved": {
- "description": "是否可操作",
- "type": "boolean"
- },
- "name": {
- "description": "名称",
- "type": "string"
- },
- "permissions": {
- "description": "权限",
- "type": "array",
- "items": {
- "$ref": "#/definitions/base.ListMapItem"
- }
- },
- "status": {
- "description": "\"enabled\", \"disabled\"",
- "type": "string"
- },
- "updated_at": {
- "description": "更新时间",
- "type": "string"
- },
- "users": {
- "description": "关联用户",
- "type": "array",
- "items": {
- "$ref": "#/definitions/base.ListMapItem"
- }
- }
- }
- },
- "admin.UserItem": {
- "type": "object",
- "properties": {
- "avatar": {
- "description": "头像",
- "type": "string"
- },
- "created_at": {
- "description": "创建时间",
- "type": "string"
- },
- "email": {
- "description": "邮箱",
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "is_reserved": {
- "type": "boolean"
- },
- "name": {
- "description": "名称",
- "type": "string"
- },
- "phone_number": {
- "description": "手机号",
- "type": "string"
- },
- "roles": {
- "description": "角色",
- "type": "array",
- "items": {
- "$ref": "#/definitions/base.ListMapItem"
- }
- },
- "status": {
- "description": "状态 \"enabled\"|\"disabled\"",
- "allOf": [
- {
- "$ref": "#/definitions/base.Status"
- }
- ]
- },
- "teams": {
- "description": "团队",
- "type": "array",
- "items": {
- "$ref": "#/definitions/base.ListMapItem"
- }
- },
- "updated_at": {
- "description": "更新时间",
- "type": "string"
- }
- }
- },
- "admin_common.Request": {
- "type": "object",
- "required": [
- "password",
- "username"
- ],
- "properties": {
- "password": {
- "description": "密码",
- "type": "string",
- "maxLength": 18,
- "minLength": 6
- },
- "username": {
- "description": "用户名",
- "type": "string",
- "maxLength": 15,
- "minLength": 5
- }
- }
- },
- "admin_role.CreateAdminRoleRequest": {
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "description": {
- "description": "非必填,描述",
- "type": "string"
- },
- "name": {
- "description": "角色名称",
- "type": "string",
- "maxLength": 15,
- "minLength": 3
- },
- "permissions": {
- "description": "权限",
- "type": "array",
- "items": {
- "type": "integer"
- }
- },
- "users": {
- "description": "管理员",
- "type": "array",
- "items": {
- "type": "integer"
- }
- }
- }
- },
- "admin_role.EnabledRoleItem": {
- "type": "object",
- "properties": {
- "description": {
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "name": {
- "type": "string"
- }
- }
- },
- "admin_role.EnabledRoles": {
- "type": "object",
- "properties": {
- "roles": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/admin_role.EnabledRoleItem"
- }
- }
- }
- },
- "admin_role.ListAdminRolesResponse": {
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/admin.RoleItem"
- }
- },
- "total_count": {
- "type": "integer"
- }
- }
- },
- "admin_role.ToggleRequest": {
- "type": "object",
- "required": [
- "status"
- ],
- "properties": {
- "status": {
- "description": "\"enabled\"|\"disabled\"",
- "allOf": [
- {
- "$ref": "#/definitions/base.Status"
- }
- ]
- }
- }
- },
- "admin_role.UpdateRequest": {
- "type": "object",
- "properties": {
- "description": {
- "description": "非必填,描述",
- "type": "string"
- },
- "permissions": {
- "description": "权限",
- "type": "array",
- "items": {
- "type": "integer"
- }
- },
- "users": {
- "description": "管理员",
- "type": "array",
- "items": {
- "type": "integer"
- }
- }
- }
- },
- "admin_user.EnabledUserItem": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "name": {
- "type": "string"
- }
- }
- },
- "admin_user.ListAdminUserResponse": {
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/admin.UserItem"
- }
- },
- "total_count": {
- "type": "integer"
- }
- }
- },
- "admin_user.ToggleRequest": {
- "type": "object",
- "required": [
- "status"
- ],
- "properties": {
- "status": {
- "description": "\"enabled\"|\"disabled\"",
- "allOf": [
- {
- "$ref": "#/definitions/base.Status"
- }
- ]
- }
- }
- },
- "admin_user.UpdateRequest": {
- "type": "object",
- "required": [
- "email",
- "phone_number"
- ],
- "properties": {
- "avatar": {
- "description": "头像",
- "type": "string"
- },
- "email": {
- "description": "邮箱",
- "type": "string"
- },
- "phone_number": {
- "description": "手机号",
- "type": "string"
- },
- "roles": {
- "description": "角色ID",
- "type": "array",
- "items": {
- "type": "integer"
- }
- },
- "teams": {
- "description": "团队ID",
- "type": "array",
- "items": {
- "type": "integer"
- }
- }
- }
- },
- "admin_user.UserRequest": {
- "type": "object",
- "required": [
- "password",
- "phone_number",
- "username"
- ],
- "properties": {
- "avatar": {
- "description": "头像",
- "type": "string"
- },
- "email": {
- "description": "邮箱",
- "type": "string"
- },
- "password": {
- "description": "密码",
- "type": "string",
- "maxLength": 18,
- "minLength": 6
- },
- "phone_number": {
- "description": "手机号",
- "type": "string"
- },
- "roles": {
- "description": "角色ID",
- "type": "array",
- "items": {
- "type": "integer"
- }
- },
- "teams": {
- "description": "团队ID",
- "type": "array",
- "items": {
- "type": "integer"
- }
- },
- "username": {
- "description": "用户名",
- "type": "string",
- "maxLength": 15,
- "minLength": 5
- }
- }
- },
- "authorization_client.AdminUserBase": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string"
- },
- "value": {
- "type": "string"
- }
- }
- },
- "authorization_client.AdminUserProfile": {
- "type": "object",
- "properties": {
- "address": {
- "type": "string"
- },
- "avatar": {
- "type": "string"
- },
- "bio": {
- "type": "string"
- },
- "birthdate": {
- "type": "integer"
- },
- "educations": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/authorization_client.AdminUserProfileEducation"
- }
- },
- "email": {
- "type": "string"
- },
- "gender": {
- "type": "integer"
- },
- "phone_number": {
- "type": "string"
- },
- "social_links": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/authorization_client.AdminUserProfileSocialLink"
- }
- },
- "website": {
- "type": "string"
- },
- "work_histories": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/authorization_client.AdminUserProfileWorkHistory"
- }
- }
- }
- },
- "authorization_client.AdminUserProfileEducation": {
- "type": "object",
- "properties": {
- "degree": {
- "type": "string"
- },
- "graduated": {
- "type": "integer"
- },
- "school": {
- "type": "string"
- }
- }
- },
- "authorization_client.AdminUserProfileSocialLink": {
- "type": "object",
- "properties": {
- "platform": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "authorization_client.AdminUserProfileWorkHistory": {
- "type": "object",
- "properties": {
- "company": {
- "type": "string"
- },
- "end_date": {
- "type": "integer"
- },
- "position": {
- "type": "string"
- },
- "responsibilities": {
- "type": "string"
- },
- "start_date": {
- "type": "integer"
- }
- }
- },
- "authorization_client.GetAdminUser": {
- "type": "object",
- "properties": {
- "profile": {
- "$ref": "#/definitions/authorization_client.AdminUserProfile"
- },
- "roles": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/authorization_client.AdminUserBase"
- }
- },
- "status": {
- "type": "string"
- },
- "teams": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/authorization_client.AdminUserBase"
- }
- },
- "user_id": {
- "type": "integer"
- },
- "username": {
- "type": "string"
- }
- }
- },
- "base.ListMapItem": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string"
- },
- "value": {
- "type": "string"
- }
- }
- },
- "base.Status": {
- "type": "string",
- "enum": [
- "ENABLED",
- "DISABLED",
- "DELETED"
- ],
- "x-enum-varnames": [
- "ToggleEnabled",
- "ToggleDisabled",
- "ToggleDeleted"
- ]
- },
- "common.UserInfo": {
- "type": "object",
- "properties": {
- "avatar": {
- "type": "string"
- },
- "email": {
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "phone_number": {
- "type": "string"
- },
- "roles": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/base.ListMapItem"
- }
- },
- "teams": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/base.ListMapItem"
- }
- },
- "username": {
- "type": "string"
- }
- }
- },
- "permission.CreateRequest": {
- "type": "object",
- "required": [
- "endpoint",
- "name"
- ],
- "properties": {
- "description": {
- "description": "非必填,描述",
- "type": "string"
- },
- "endpoint": {
- "type": "string"
- },
- "name": {
- "description": "权限名称",
- "type": "string",
- "maxLength": 50,
- "minLength": 3
- },
- "roles": {
- "description": "角色",
- "type": "array",
- "items": {
- "type": "integer"
- }
- }
- }
- },
- "permission.ListResponse": {
- "type": "object",
- "properties": {
- "items": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/admin.AdminPermission"
- }
- },
- "total_count": {
- "type": "integer"
- }
- }
- },
- "permission.ToggleRequest": {
- "type": "object",
- "required": [
- "status"
- ],
- "properties": {
- "status": {
- "description": "\"enabled\"|\"disabled\"",
- "allOf": [
- {
- "$ref": "#/definitions/base.Status"
- }
- ]
- }
- }
- },
- "permission.UpdateRequest": {
- "type": "object",
- "properties": {
- "description": {
- "description": "非必填,描述",
- "type": "string"
- },
- "roles": {
- "description": "角色",
- "type": "array",
- "items": {
- "type": "integer"
- }
- }
- }
- },
- "response.ApiResponse": {
- "type": "object",
- "properties": {
- "code": {
- "type": "integer"
- },
- "data": {},
- "message": {
- "type": "string"
- }
- }
- }
- },
- "securityDefinitions": {
- "BasicAuth": {
- "type": "basic"
- }
- },
- "externalDocs": {
- "description": "OpenAPI",
- "url": "https://swagger.io/resources/open-api/"
- }
- }
|