提交
This commit is contained in:
87
docs/apis/captcha.js
Normal file
87
docs/apis/captcha.js
Normal file
@@ -0,0 +1,87 @@
|
||||
/**
|
||||
* @swagger
|
||||
* tags:
|
||||
* name: Captcha
|
||||
* description: 验证码API
|
||||
*/
|
||||
/**
|
||||
* @swagger
|
||||
* /captcha/generate:
|
||||
* get:
|
||||
* summary: 生成图形验证码
|
||||
* tags: [Captcha]
|
||||
* responses:
|
||||
* 200:
|
||||
* description: 成功生成验证码
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* data:
|
||||
* type: object
|
||||
* properties:
|
||||
* captchaId:
|
||||
* type: string
|
||||
* description: 验证码唯一ID
|
||||
* image:
|
||||
* type: string
|
||||
* description: Base64编码的SVG验证码图片
|
||||
* 500:
|
||||
* description: 服务器错误
|
||||
*/
|
||||
/**
|
||||
* @swagger
|
||||
* /captcha/verify:
|
||||
* post:
|
||||
* summary: 验证用户输入的验证码
|
||||
* tags: [Captcha]
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - captchaId
|
||||
* - captchaText
|
||||
* properties:
|
||||
* captchaId:
|
||||
* type: string
|
||||
* description: 验证码唯一ID
|
||||
* captchaText:
|
||||
* type: string
|
||||
* description: 用户输入的验证码
|
||||
* responses:
|
||||
* 200:
|
||||
* description: 验证码验证成功
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* message:
|
||||
* type: string
|
||||
* example: 验证码验证成功
|
||||
* 400:
|
||||
* description: 验证码错误或已过期
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: false
|
||||
* message:
|
||||
* type: string
|
||||
* example: 验证码错误
|
||||
* 500:
|
||||
* description: 服务器错误
|
||||
*/
|
||||
159
docs/apis/matching.js
Normal file
159
docs/apis/matching.js
Normal file
@@ -0,0 +1,159 @@
|
||||
/**
|
||||
* @swagger
|
||||
* tags:
|
||||
* name: Matching
|
||||
* description: 匹配订单相关接口
|
||||
*/
|
||||
/**
|
||||
* @swagger
|
||||
* /api/matching/my-orders:
|
||||
* get:
|
||||
* summary: 获取用户的匹配订单列表
|
||||
* tags: [Matching]
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: query
|
||||
* name: page
|
||||
* schema:
|
||||
* type: integer
|
||||
* default: 1
|
||||
* description: 页码
|
||||
* - in: query
|
||||
* name: limit
|
||||
* schema:
|
||||
* type: integer
|
||||
* default: 10
|
||||
* description: 每页数量
|
||||
* responses:
|
||||
* 200:
|
||||
* description: 成功获取匹配订单列表
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* data:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: '#/components/schemas/MatchingOrder'
|
||||
* 401:
|
||||
* description: 未授权
|
||||
* 500:
|
||||
* description: 服务器错误
|
||||
*/
|
||||
/**
|
||||
* @swagger
|
||||
* components:
|
||||
* schemas:
|
||||
* MatchingOrder:
|
||||
* type: object
|
||||
* properties:
|
||||
* id:
|
||||
* type: integer
|
||||
* description: 匹配订单ID
|
||||
* initiator_id:
|
||||
* type: integer
|
||||
* description: 发起人ID
|
||||
* matching_type:
|
||||
* type: string
|
||||
* enum: [small, large]
|
||||
* description: 匹配类型（小额或大额）
|
||||
* amount:
|
||||
* type: number
|
||||
* description: 匹配总金额
|
||||
* status:
|
||||
* type: string
|
||||
* enum: [pending, matching, completed, failed]
|
||||
* description: 订单状态
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* description: 创建时间
|
||||
* Allocation:
|
||||
* type: object
|
||||
* properties:
|
||||
* id:
|
||||
* type: integer
|
||||
* description: 分配ID
|
||||
* from_user_id:
|
||||
* type: integer
|
||||
* description: 发送方用户ID
|
||||
* to_user_id:
|
||||
* type: integer
|
||||
* description: 接收方用户ID
|
||||
* amount:
|
||||
* type: number
|
||||
* description: 分配金额
|
||||
* cycle_number:
|
||||
* type: integer
|
||||
* description: 轮次编号
|
||||
* status:
|
||||
* type: string
|
||||
* enum: [pending, confirmed, rejected, cancelled]
|
||||
* description: 分配状态
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* description: 创建时间
|
||||
*/
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/matching/create:
|
||||
* post:
|
||||
* summary: 创建匹配订单
|
||||
* tags: [Matching]
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* matchingType:
|
||||
* type: string
|
||||
* enum: [small, large]
|
||||
* default: small
|
||||
* description: 匹配类型（小额或大额）
|
||||
* customAmount:
|
||||
* type: number
|
||||
* description: 大额匹配时的自定义金额（5000-50000之间）
|
||||
* responses:
|
||||
* 200:
|
||||
* description: 匹配订单创建成功
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* message:
|
||||
* type: string
|
||||
* data:
|
||||
* type: object
|
||||
* properties:
|
||||
* matchingOrderId:
|
||||
* type: integer
|
||||
* amounts:
|
||||
* type: array
|
||||
* items:
|
||||
* type: number
|
||||
* matchingType:
|
||||
* type: string
|
||||
* totalAmount:
|
||||
* type: number
|
||||
* 400:
|
||||
* description: 参数错误或用户未满足匹配条件
|
||||
* 401:
|
||||
* description: 未授权
|
||||
* 404:
|
||||
* description: 用户不存在
|
||||
* 500:
|
||||
* description: 服务器错误
|
||||
*/
|
||||
388
docs/apis/transfers.js
Normal file
388
docs/apis/transfers.js
Normal file
@@ -0,0 +1,388 @@
|
||||
/**
|
||||
* @swagger
|
||||
* components:
|
||||
* schemas:
|
||||
* Transfer:
|
||||
* type: object
|
||||
* properties:
|
||||
* id:
|
||||
* type: integer
|
||||
* description: 转账记录ID
|
||||
* user_id:
|
||||
* type: integer
|
||||
* description: 用户ID
|
||||
* recipient_id:
|
||||
* type: integer
|
||||
* description: 接收方用户ID
|
||||
* amount:
|
||||
* type: number
|
||||
* format: float
|
||||
* description: 转账金额
|
||||
* status:
|
||||
* type: string
|
||||
* enum: [pending, completed, failed, cancelled]
|
||||
* description: 转账状态
|
||||
* transfer_type:
|
||||
* type: string
|
||||
* enum: [user_to_user, user_to_system, system_to_user]
|
||||
* description: 转账类型
|
||||
* voucher_image:
|
||||
* type: string
|
||||
* description: 转账凭证图片路径
|
||||
* remark:
|
||||
* type: string
|
||||
* description: 转账备注
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* description: 创建时间
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* description: 更新时间
|
||||
* Pagination:
|
||||
* type: object
|
||||
* properties:
|
||||
* total:
|
||||
* type: integer
|
||||
* description: 总记录数
|
||||
* page:
|
||||
* type: integer
|
||||
* description: 当前页码
|
||||
* limit:
|
||||
* type: integer
|
||||
* description: 每页记录数
|
||||
* total_pages:
|
||||
* type: integer
|
||||
* description: 总页数
|
||||
*/
|
||||
/**
|
||||
* @swagger
|
||||
* /transfers:
|
||||
* get:
|
||||
* summary: 获取转账列表
|
||||
* tags: [Transfers]
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: query
|
||||
* name: status
|
||||
* schema:
|
||||
* type: string
|
||||
* description: 转账状态过滤
|
||||
* - in: query
|
||||
* name: transfer_type
|
||||
* schema:
|
||||
* type: string
|
||||
* description: 转账类型过滤
|
||||
* - in: query
|
||||
* name: start_date
|
||||
* schema:
|
||||
* type: string
|
||||
* format: date
|
||||
* description: 开始日期过滤
|
||||
* - in: query
|
||||
* name: end_date
|
||||
* schema:
|
||||
* type: string
|
||||
* format: date
|
||||
* description: 结束日期过滤
|
||||
* - in: query
|
||||
* name: search
|
||||
* schema:
|
||||
* type: string
|
||||
* description: 搜索关键词（用户名或真实姓名）
|
||||
* - in: query
|
||||
* name: page
|
||||
* schema:
|
||||
* type: integer
|
||||
* default: 1
|
||||
* description: 页码
|
||||
* - in: query
|
||||
* name: limit
|
||||
* schema:
|
||||
* type: integer
|
||||
* default: 10
|
||||
* description: 每页数量
|
||||
* - in: query
|
||||
* name: sort
|
||||
* schema:
|
||||
* type: string
|
||||
* description: 排序字段
|
||||
* - in: query
|
||||
* name: order
|
||||
* schema:
|
||||
* type: string
|
||||
* enum: [asc, desc]
|
||||
* description: 排序方向
|
||||
* responses:
|
||||
* 200:
|
||||
* description: 成功获取转账列表
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* data:
|
||||
* type: object
|
||||
* properties:
|
||||
* transfers:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: '#/components/schemas/Transfer'
|
||||
* pagination:
|
||||
* $ref: '#/components/schemas/Pagination'
|
||||
* 401:
|
||||
* description: 未授权
|
||||
* 500:
|
||||
* description: 服务器错误
|
||||
*/
|
||||
/**
|
||||
* @swagger
|
||||
* /transfers/list:
|
||||
* get:
|
||||
* summary: 获取转账记录列表
|
||||
* tags: [Transfers]
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: query
|
||||
* name: status
|
||||
* schema:
|
||||
* type: string
|
||||
* description: 转账状态过滤
|
||||
* - in: query
|
||||
* name: transfer_type
|
||||
* schema:
|
||||
* type: string
|
||||
* description: 转账类型过滤
|
||||
* - in: query
|
||||
* name: start_date
|
||||
* schema:
|
||||
* type: string
|
||||
* format: date
|
||||
* description: 开始日期过滤
|
||||
* - in: query
|
||||
* name: end_date
|
||||
* schema:
|
||||
* type: string
|
||||
* format: date
|
||||
* description: 结束日期过滤
|
||||
* - in: query
|
||||
* name: page
|
||||
* schema:
|
||||
* type: integer
|
||||
* default: 1
|
||||
* description: 页码
|
||||
* - in: query
|
||||
* name: limit
|
||||
* schema:
|
||||
* type: integer
|
||||
* default: 10
|
||||
* description: 每页数量
|
||||
* - in: query
|
||||
* name: sort
|
||||
* schema:
|
||||
* type: string
|
||||
* description: 排序字段
|
||||
* - in: query
|
||||
* name: order
|
||||
* schema:
|
||||
* type: string
|
||||
* enum: [asc, desc]
|
||||
* description: 排序方向
|
||||
* responses:
|
||||
* 200:
|
||||
* description: 成功获取转账记录列表
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* data:
|
||||
* type: object
|
||||
* properties:
|
||||
* transfers:
|
||||
* type: array
|
||||
* items:
|
||||
* $ref: '#/components/schemas/Transfer'
|
||||
* pagination:
|
||||
* $ref: '#/components/schemas/Pagination'
|
||||
* 401:
|
||||
* description: 未授权
|
||||
* 500:
|
||||
* description: 服务器错误
|
||||
*/
|
||||
/**
|
||||
* @swagger
|
||||
* /transfers/public-account:
|
||||
* get:
|
||||
* summary: 获取公户信息
|
||||
* tags: [Transfers]
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* responses:
|
||||
* 200:
|
||||
* description: 成功获取公户信息
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* data:
|
||||
* type: object
|
||||
* properties:
|
||||
* id:
|
||||
* type: integer
|
||||
* description: 公户ID
|
||||
* username:
|
||||
* type: string
|
||||
* description: 公户用户名
|
||||
* example: public_account
|
||||
* real_name:
|
||||
* type: string
|
||||
* description: 公户名称
|
||||
* balance:
|
||||
* type: number
|
||||
* format: float
|
||||
* description: 公户余额
|
||||
* 401:
|
||||
* description: 未授权
|
||||
* 404:
|
||||
* description: 公户不存在
|
||||
* 500:
|
||||
* description: 服务器错误
|
||||
*/
|
||||
/**
|
||||
* @swagger
|
||||
* /transfers/create:
|
||||
* post:
|
||||
* summary: 创建转账记录
|
||||
* tags: [Transfers]
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - to_user_id
|
||||
* - amount
|
||||
* - transfer_type
|
||||
* properties:
|
||||
* to_user_id:
|
||||
* type: integer
|
||||
* description: 接收方用户ID
|
||||
* amount:
|
||||
* type: number
|
||||
* format: float
|
||||
* description: 转账金额
|
||||
* transfer_type:
|
||||
* type: string
|
||||
* enum: [user_to_user, user_to_system, system_to_user]
|
||||
* description: 转账类型
|
||||
* remark:
|
||||
* type: string
|
||||
* description: 转账备注
|
||||
* responses:
|
||||
* 201:
|
||||
* description: 转账记录创建成功
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* message:
|
||||
* type: string
|
||||
* example: 转账记录创建成功，等待确认
|
||||
* data:
|
||||
* type: object
|
||||
* properties:
|
||||
* transfer_id:
|
||||
* type: integer
|
||||
* description: 转账记录ID
|
||||
* 400:
|
||||
* description: 请求参数错误
|
||||
* 401:
|
||||
* description: 未授权
|
||||
* 500:
|
||||
* description: 服务器错误
|
||||
*/
|
||||
/**
|
||||
* @swagger
|
||||
* /transfers/admin/create:
|
||||
* post:
|
||||
* summary: 管理员创建转账记录
|
||||
* tags: [Transfers]
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - from_user_id
|
||||
* - to_user_id
|
||||
* - amount
|
||||
* - transfer_type
|
||||
* properties:
|
||||
* from_user_id:
|
||||
* type: integer
|
||||
* description: 发送方用户ID
|
||||
* to_user_id:
|
||||
* type: integer
|
||||
* description: 接收方用户ID
|
||||
* amount:
|
||||
* type: number
|
||||
* format: float
|
||||
* description: 转账金额
|
||||
* transfer_type:
|
||||
* type: string
|
||||
* enum: [user_to_user, user_to_system, system_to_user]
|
||||
* description: 转账类型
|
||||
* description:
|
||||
* type: string
|
||||
* description: 转账描述
|
||||
* responses:
|
||||
* 201:
|
||||
* description: 转账记录创建成功
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* message:
|
||||
* type: string
|
||||
* example: 转账记录创建成功
|
||||
* data:
|
||||
* type: object
|
||||
* properties:
|
||||
* transfer_id:
|
||||
* type: integer
|
||||
* description: 转账记录ID
|
||||
* 400:
|
||||
* description: 请求参数错误
|
||||
* 401:
|
||||
* description: 未授权
|
||||
* 403:
|
||||
* description: 权限不足
|
||||
* 500:
|
||||
* description: 服务器错误
|
||||
*/
|
||||
367
docs/apis/user.js
Normal file
367
docs/apis/user.js
Normal file
@@ -0,0 +1,367 @@
|
||||
/**
|
||||
* @swagger
|
||||
* tags:
|
||||
* name: Authentication
|
||||
* description: 用户认证API
|
||||
*/
|
||||
/**
|
||||
* @swagger
|
||||
* components:
|
||||
* schemas:
|
||||
* LoginCredentials:
|
||||
* type: object
|
||||
* required:
|
||||
* - username
|
||||
* - password
|
||||
* properties:
|
||||
* username:
|
||||
* type: string
|
||||
* description: 用户名或手机号
|
||||
* password:
|
||||
* type: string
|
||||
* description: 密码
|
||||
* RegisterRequest:
|
||||
* type: object
|
||||
* required:
|
||||
* - username
|
||||
* - phone
|
||||
* - password
|
||||
* - registrationCode
|
||||
* - city
|
||||
* - district_id
|
||||
* - captchaId
|
||||
* - captchaText
|
||||
* - smsCode
|
||||
* properties:
|
||||
* username:
|
||||
* type: string
|
||||
* description: 用户名
|
||||
* phone:
|
||||
* type: string
|
||||
* description: 手机号
|
||||
* password:
|
||||
* type: string
|
||||
* description: 密码
|
||||
* registrationCode:
|
||||
* type: string
|
||||
* description: 注册激活码
|
||||
* city:
|
||||
* type: string
|
||||
* description: 城市
|
||||
* district_id:
|
||||
* type: string
|
||||
* description: 区域ID
|
||||
* captchaId:
|
||||
* type: string
|
||||
* description: 图形验证码ID
|
||||
* captchaText:
|
||||
* type: string
|
||||
* description: 图形验证码文本
|
||||
* smsCode:
|
||||
* type: string
|
||||
* description: 短信验证码
|
||||
* role:
|
||||
* type: string
|
||||
* description: 用户角色
|
||||
* default: user
|
||||
*/
|
||||
/**
|
||||
* @swagger
|
||||
* /auth/register:
|
||||
* post:
|
||||
* summary: 用户注册
|
||||
* description: 需要提供有效的激活码才能注册
|
||||
* tags: [Authentication]
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/RegisterRequest'
|
||||
* responses:
|
||||
* 201:
|
||||
* description: 用户注册成功
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* message:
|
||||
* type: string
|
||||
* token:
|
||||
* type: string
|
||||
* description: JWT认证令牌
|
||||
* user:
|
||||
* type: object
|
||||
* properties:
|
||||
* id:
|
||||
* type: integer
|
||||
* username:
|
||||
* type: string
|
||||
* role:
|
||||
* type: string
|
||||
* 400:
|
||||
* description: 请求参数错误
|
||||
* 500:
|
||||
* description: 服务器错误
|
||||
*/
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /auth/login:
|
||||
* post:
|
||||
* summary: 用户登录
|
||||
* tags: [Authentication]
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/LoginCredentials'
|
||||
* responses:
|
||||
* 200:
|
||||
* description: 登录成功
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* message:
|
||||
* type: string
|
||||
* token:
|
||||
* type: string
|
||||
* description: JWT认证令牌
|
||||
* user:
|
||||
* type: object
|
||||
* properties:
|
||||
* id:
|
||||
* type: integer
|
||||
* username:
|
||||
* type: string
|
||||
* role:
|
||||
* type: string
|
||||
* avatar:
|
||||
* type: string
|
||||
* points:
|
||||
* type: integer
|
||||
* 400:
|
||||
* description: 请求参数错误
|
||||
* 401:
|
||||
* description: 用户名或密码错误
|
||||
* 403:
|
||||
* description: 账户审核未通过
|
||||
* 500:
|
||||
* description: 服务器错误
|
||||
*/
|
||||
/**
|
||||
* @swagger
|
||||
* /api/users/{id}/distribute:
|
||||
* put:
|
||||
* summary: 设置用户分发状态
|
||||
* description: 更新指定用户的分发状态
|
||||
* tags: [Users]
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: 用户ID
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - is_distribute
|
||||
* properties:
|
||||
* is_distribute:
|
||||
* type: boolean
|
||||
* description: 分发状态，true为启用分发，false为禁用分发
|
||||
* example: true
|
||||
* responses:
|
||||
* 200:
|
||||
* description: 分发状态更新成功
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: true
|
||||
* message:
|
||||
* type: string
|
||||
* example: "分发状态更新成功"
|
||||
* is_distribute:
|
||||
* type: boolean
|
||||
* description: 更新后的分发状态
|
||||
* example: true
|
||||
* 400:
|
||||
* description: 请求参数错误
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: false
|
||||
* message:
|
||||
* type: string
|
||||
* example: "分发状态无效"
|
||||
* 404:
|
||||
* description: 用户不存在
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: false
|
||||
* message:
|
||||
* type: string
|
||||
* example: "用户不存在"
|
||||
* 500:
|
||||
* description: 服务器内部错误
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* example: false
|
||||
* message:
|
||||
* type: string
|
||||
* example: "服务器内部错误"
|
||||
*/
|
||||
/**
|
||||
* @swagger
|
||||
* components:
|
||||
* schemas:
|
||||
* User:
|
||||
* type: object
|
||||
* required:
|
||||
* - username
|
||||
* - password
|
||||
* - real_name
|
||||
* - id_card
|
||||
* properties:
|
||||
* id:
|
||||
* type: integer
|
||||
* description: 用户ID
|
||||
* username:
|
||||
* type: string
|
||||
* description: 用户名
|
||||
* role:
|
||||
* type: string
|
||||
* description: 用户角色
|
||||
* enum: [user, admin, merchant]
|
||||
* avatar:
|
||||
* type: string
|
||||
* description: 用户头像URL
|
||||
* points:
|
||||
* type: integer
|
||||
* description: 用户积分
|
||||
* real_name:
|
||||
* type: string
|
||||
* description: 真实姓名
|
||||
* id_card:
|
||||
* type: string
|
||||
* description: 身份证号
|
||||
* phone:
|
||||
* type: string
|
||||
* description: 手机号
|
||||
* is_system_account:
|
||||
* type: boolean
|
||||
* description: 是否为系统账户
|
||||
* is_distribute:
|
||||
* type: boolean
|
||||
* description: 是否为分发账户
|
||||
* created_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* description: 创建时间
|
||||
* updated_at:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* description: 更新时间
|
||||
*/
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /users:
|
||||
* post:
|
||||
* summary: 创建用户（管理员权限）
|
||||
* tags: [Users]
|
||||
* security:
|
||||
* - bearerAuth: []
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - username
|
||||
* - password
|
||||
* - real_name
|
||||
* - id_card
|
||||
* properties:
|
||||
* username:
|
||||
* type: string
|
||||
* password:
|
||||
* type: string
|
||||
* role:
|
||||
* type: string
|
||||
* enum: [user, admin, merchant]
|
||||
* default: user
|
||||
* is_system_account:
|
||||
* type: boolean
|
||||
* default: false
|
||||
* real_name:
|
||||
* type: string
|
||||
* id_card:
|
||||
* type: string
|
||||
* wechat_qr:
|
||||
* type: string
|
||||
* alipay_qr:
|
||||
* type: string
|
||||
* bank_card:
|
||||
* type: string
|
||||
* unionpay_qr:
|
||||
* type: string
|
||||
* phone:
|
||||
* type: string
|
||||
* responses:
|
||||
* 201:
|
||||
* description: 用户创建成功
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* message:
|
||||
* type: string
|
||||
* user:
|
||||
* $ref: '#/components/schemas/User'
|
||||
* 400:
|
||||
* description: 请求参数错误
|
||||
* 401:
|
||||
* description: 未授权
|
||||
* 403:
|
||||
* description: 权限不足
|
||||
* 500:
|
||||
* description: 服务器错误
|
||||
*/
|
||||
Reference in New Issue
Block a user