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