haibei/internal/swagger/swagger.yaml
2025-06-19 10:33:58 +08:00

4965 lines
121 KiB
YAML

definitions:
api.CheckQrCodeStruct:
properties:
customer_id:
type: integer
reception_center_id:
type: integer
type: object
errors.Error:
properties:
code:
type: integer
detail:
type: string
id:
type: string
status:
type: string
type: object
schema.Activity:
properties:
address:
type: string
areaId:
type: integer
content:
type: string
cover:
type: string
createdAt:
type: string
createdId:
type: integer
deletedAt:
type: integer
deletedId:
type: integer
endAt:
type: string
endSignupAt:
type: string
id:
type: integer
images:
items:
type: string
type: array
maxSignupNum:
type: integer
point:
type: integer
signupNum:
type: integer
startAt:
type: string
status:
type: string
title:
type: string
updatedAt:
type: string
type: object
schema.ActivityDetail:
properties:
activityId:
type: integer
createdAt:
type: string
createdId:
type: integer
customerId:
type: integer
deletedAt:
type: integer
deletedId:
type: integer
id:
type: integer
status:
type: string
updatedAt:
type: string
type: object
schema.ActivityDetailForm:
properties:
activityId:
type: integer
customerId:
type: integer
status:
type: string
type: object
schema.ActivityForm:
properties:
address:
type: string
areaId:
type: integer
content:
type: string
cover:
type: string
endAt:
type: string
endSignupAt:
type: string
images:
items:
type: string
type: array
maxSignupNum:
type: integer
point:
type: integer
signupNum:
type: integer
startAt:
type: string
status:
type: string
title:
type: string
type: object
schema.Area:
properties:
createdAt:
type: string
createdId:
type: integer
deletedAt:
type: integer
deletedId:
type: integer
id:
type: integer
name:
type: string
status:
type: string
updatedAt:
type: string
type: object
schema.AreaForm:
properties:
name:
type: string
status:
type: string
type: object
schema.Balance:
properties:
after:
type: integer
before:
type: integer
change:
type: integer
createdAt:
type: string
createdId:
type: integer
creatorId:
type: string
customerId:
type: integer
deletedAt:
type: integer
deletedId:
type: integer
id:
type: integer
operatorId:
type: integer
reason:
type: string
type:
type: string
updatedAt:
type: string
type: object
schema.BalanceForm:
properties:
after:
type: integer
before:
type: integer
change:
type: integer
creatorId:
type: string
customerId:
type: integer
operatorId:
type: integer
reason:
type: string
type:
type: string
type: object
schema.Banner:
properties:
areaId:
type: integer
createdAt:
type: string
createdId:
type: integer
deletedAt:
type: integer
deletedId:
type: integer
id:
type: integer
img:
type: string
link:
type: string
name:
type: string
sequence:
type: integer
status:
type: string
updatedAt:
type: string
type: object
schema.BannerForm:
properties:
areaId:
type: integer
img:
type: string
link:
type: string
name:
type: string
sequence:
type: integer
status:
type: string
type: object
schema.Captcha:
properties:
captcha_id:
description: Captcha ID
type: string
type: object
schema.Common:
properties:
created_at:
description: Create time
type: string
id:
description: Unique ID
type: string
updated_at:
description: Update time
type: string
type: object
schema.CommonForm:
type: object
schema.Company:
properties:
areaId:
type: integer
createdAt:
type: string
createdId:
type: integer
deletedAt:
type: integer
deletedId:
type: integer
id:
type: integer
img:
type: string
name:
type: string
status:
type: string
updatedAt:
type: string
type: object
schema.CompanyForm:
properties:
areaId:
type: integer
img:
type: string
name:
type: string
status:
type: string
type: object
schema.Customer:
properties:
areaId:
type: integer
avatar:
type: string
balance:
type: integer
birthday:
type: string
companyId:
type: integer
createdAt:
type: string
createdId:
type: integer
deletedAt:
type: integer
deletedId:
type: integer
grade:
type: integer
id:
type: integer
inviterId:
type: integer
mentorId:
type: string
name:
type: string
phone:
type: string
status:
type: string
updatedAt:
type: string
wxSign:
type: string
type: object
schema.CustomerForm:
properties:
areaId:
type: integer
avatar:
type: string
balance:
type: integer
birthday:
type: string
companyId:
type: integer
grade:
type: integer
inviterId:
type: integer
name:
type: string
phone:
type: string
status:
type: string
wxSign:
type: string
type: object
schema.Grade:
properties:
createdAt:
type: string
createdId:
type: integer
deletedAt:
type: integer
deletedId:
type: integer
icon:
type: string
id:
type: integer
introduce:
type: string
lv:
type: string
name:
type: string
score:
type: integer
status:
type: string
updatedAt:
type: string
type: object
schema.GradeForm:
properties:
icon:
type: string
introduce:
type: string
lv:
type: string
name:
type: string
score:
type: integer
status:
type: string
type: object
schema.Logger:
properties:
created_at:
description: Create time
type: string
data:
description: Log data
type: string
id:
description: Unique ID
type: string
level:
description: Log level
type: string
login_name:
description: From User.Username
type: string
message:
description: Log message
type: string
stack:
description: Error stack
type: string
tag:
description: Log tag
type: string
trace_id:
description: Trace ID
type: string
user_id:
description: User ID
type: string
user_name:
description: From User.Name
type: string
type: object
schema.LoginForm:
properties:
captcha_code:
description: Captcha verify code
type: string
captcha_id:
description: Captcha verify id
type: string
password:
description: Login password (md5 hash)
type: string
username:
description: Login name
type: string
required:
- captcha_code
- captcha_id
- password
- username
type: object
schema.LoginToken:
properties:
access_token:
description: Access token (JWT)
type: string
expires_at:
description: 'Expired time (Unit: second)'
type: integer
token_type:
description: 'Token type (Usage: Authorization=${token_type} ${access_token})'
type: string
type: object
schema.Menu:
properties:
children:
description: Child menus
items:
$ref: '#/definitions/schema.Menu'
type: array
code:
description: Code of menu (unique for each level)
type: string
created_at:
description: Create time
type: string
description:
description: Details about menu
type: string
id:
description: Unique ID
type: string
name:
description: Display name of menu
type: string
parent_id:
description: Parent ID (From Menu.ID)
type: string
parent_path:
description: Parent path (split by .)
type: string
path:
description: Access path of menu
type: string
properties:
description: Properties of menu (JSON)
type: string
resources:
description: Resources of menu
items:
$ref: '#/definitions/schema.MenuResource'
type: array
sequence:
description: Sequence for sorting (Order by desc)
type: integer
status:
description: Status of menu (enabled, disabled)
type: string
type:
description: Type of menu (page, button)
type: string
updated_at:
description: Update time
type: string
type: object
schema.MenuForm:
properties:
code:
description: Code of menu (unique for each level)
maxLength: 32
type: string
description:
description: Details about menu
type: string
name:
description: Display name of menu
maxLength: 128
type: string
parent_id:
description: Parent ID (From Menu.ID)
type: string
path:
description: Access path of menu
type: string
properties:
description: Properties of menu (JSON)
type: string
resources:
description: Resources of menu
items:
$ref: '#/definitions/schema.MenuResource'
type: array
sequence:
description: Sequence for sorting (Order by desc)
type: integer
status:
description: Status of menu (enabled, disabled)
enum:
- disabled
- enabled
type: string
type:
description: Type of menu (page, button)
enum:
- page
- button
type: string
required:
- code
- name
- status
- type
type: object
schema.MenuResource:
properties:
created_at:
description: Create time
type: string
id:
description: Unique ID
type: string
menu_id:
description: From Menu.ID
type: string
method:
description: HTTP method
type: string
path:
description: API request path (e.g. /api/v1/users/:id)
type: string
updated_at:
description: Update time
type: string
type: object
schema.Notice:
properties:
areaId:
type: integer
content:
type: string
createdAt:
type: string
createdId:
type: integer
deletedAt:
type: integer
deletedId:
type: integer
id:
type: integer
sequence:
type: integer
status:
type: string
title:
type: string
updatedAt:
type: string
type: object
schema.NoticeForm:
properties:
areaId:
type: integer
content:
type: string
sequence:
type: integer
status:
type: string
title:
type: string
type: object
schema.Point:
properties:
created_at:
description: Create time
type: string
id:
description: Unique ID
type: string
updated_at:
description: Update time
type: string
type: object
schema.PointForm:
type: object
schema.Product:
properties:
areaId:
type: integer
businessImgs:
items:
type: string
type: array
category:
allOf:
- $ref: '#/definitions/schema.ProductCategory'
description: 关联分类
categoryId:
type: integer
cover:
type: string
createdAt:
type: string
createdId:
type: integer
deletedAt:
type: integer
deletedId:
type: integer
details:
type: string
expireAt:
type: string
id:
type: integer
instructions:
type: string
isHot:
type: boolean
maxNum:
type: integer
name:
type: string
policy:
type: string
price:
type: integer
status:
type: string
stock:
type: integer
type:
type: string
updatedAt:
type: string
type: object
schema.ProductCategory:
properties:
createdAt:
type: string
createdId:
type: integer
deletedAt:
type: integer
deletedId:
type: integer
icon:
type: string
id:
type: integer
introduce:
type: string
name:
type: string
parentId:
type: integer
status:
type: string
updatedAt:
type: string
type: object
schema.ProductCategoryForm:
properties:
icon:
type: string
introduce:
type: string
name:
type: string
parentId:
type: integer
status:
type: string
type: object
schema.ProductForm:
properties:
areaId:
type: integer
businessImgs:
items:
type: string
type: array
categoryId:
type: integer
cover:
type: string
details:
type: string
expireAt:
type: string
instructions:
type: string
isHot:
type: boolean
maxNum:
type: integer
name:
type: string
policy:
type: string
price:
type: integer
status:
type: string
stock:
type: integer
type:
type: string
type: object
schema.ProductOrder:
properties:
createdAt:
type: string
createdId:
type: integer
customerId:
type: integer
deletedAt:
type: integer
deletedId:
type: integer
id:
type: integer
mentorId:
type: string
productId:
type: integer
status:
type: string
updatedAt:
type: string
type: object
schema.ProductOrderForm:
properties:
customerId:
type: integer
mentorId:
type: string
productId:
type: integer
status:
type: string
type: object
schema.QeustionDetail:
properties:
content:
items:
$ref: '#/definitions/schema.QuestionDetailTable'
type: array
createdAt:
type: string
createdId:
type: integer
customerId:
type: integer
deletedAt:
type: integer
deletedId:
type: integer
id:
type: integer
questionId:
type: integer
status:
type: string
updatedAt:
type: string
type: object
schema.QeustionDetailForm:
properties:
content:
items:
$ref: '#/definitions/schema.QuestionDetailTable'
type: array
customerId:
type: integer
questionId:
type: integer
status:
type: string
type: object
schema.QuestionDetailTable:
properties:
answer:
type: string
label:
type: string
options:
items:
type: string
type: array
required:
type: boolean
type:
type: string
type: object
schema.Questionnaire:
properties:
areaId:
type: integer
content:
items:
$ref: '#/definitions/schema.QuestionnaireTable'
type: array
cover:
type: string
createdAt:
type: string
createdId:
type: integer
deletedAt:
type: integer
deletedId:
type: integer
endAt:
type: string
id:
type: integer
point:
type: integer
startAt:
type: string
status:
type: string
title:
type: string
updatedAt:
type: string
type: object
schema.QuestionnaireForm:
properties:
areaId:
type: integer
content:
items:
$ref: '#/definitions/schema.QuestionnaireTable'
type: array
cover:
type: string
endAt:
type: string
point:
type: integer
startAt:
type: string
status:
type: string
title:
type: string
type: object
schema.QuestionnaireTable:
properties:
label:
type: string
options:
items:
type: string
type: array
required:
type: boolean
type:
type: string
type: object
schema.ReceptionCenter:
properties:
areaId:
type: integer
createdAt:
type: string
createdId:
type: integer
deletedAt:
type: integer
deletedId:
type: integer
id:
type: integer
introduce:
type: string
name:
type: string
status:
type: string
updatedAt:
type: string
type: object
schema.ReceptionCenterForm:
properties:
areaId:
type: integer
introduce:
type: string
name:
type: string
status:
type: string
type: object
schema.Role:
properties:
code:
description: Code of role (unique)
type: string
created_at:
description: Create time
type: string
description:
description: Details about role
type: string
id:
description: Unique ID
type: string
menus:
description: Role menu list
items:
$ref: '#/definitions/schema.RoleMenu'
type: array
name:
description: Display name of role
type: string
sequence:
description: Sequence for sorting
type: integer
status:
description: Status of role (disabled, enabled)
type: string
updated_at:
description: Update time
type: string
type: object
schema.RoleForm:
properties:
code:
description: Code of role (unique)
maxLength: 32
type: string
description:
description: Details about role
type: string
menus:
description: Role menu list
items:
$ref: '#/definitions/schema.RoleMenu'
type: array
name:
description: Display name of role
maxLength: 128
type: string
sequence:
description: Sequence for sorting
type: integer
status:
description: Status of role (enabled, disabled)
enum:
- disabled
- enabled
type: string
required:
- code
- name
- status
type: object
schema.RoleMenu:
properties:
created_at:
description: Create time
type: string
id:
description: Unique ID
type: string
menu_id:
description: From Menu.ID
type: string
role_id:
description: From Role.ID
type: string
updated_at:
description: Update time
type: string
type: object
schema.UpdateCurrentUser:
properties:
email:
description: Email of user
maxLength: 128
type: string
name:
description: Name of user
maxLength: 64
type: string
phone:
description: Phone number of user
maxLength: 32
type: string
remark:
description: Remark of user
maxLength: 1024
type: string
required:
- name
type: object
schema.UpdateLoginPassword:
properties:
new_password:
description: New password (md5 hash)
type: string
old_password:
description: Old password (md5 hash)
type: string
required:
- new_password
- old_password
type: object
schema.User:
properties:
companyId:
description: Remark of user
type: integer
created_at:
description: Create time
type: string
email:
type: string
id:
description: Unique ID
type: string
name:
description: Name of user
type: string
phone:
description: Phone number of user
type: string
remark:
description: Remark of user
type: string
roles:
description: Roles of user
items:
$ref: '#/definitions/schema.UserRole'
type: array
status:
description: Status of user (activated, freezed)
type: string
updated_at:
description: Update time
type: string
username:
description: Username for login
type: string
type: object
schema.UserForm:
properties:
email:
description: Email of user
maxLength: 128
type: string
name:
description: Name of user
maxLength: 64
type: string
password:
description: Password for login (md5 hash)
maxLength: 64
type: string
phone:
description: Phone number of user
maxLength: 32
type: string
remark:
description: Remark of user
maxLength: 1024
type: string
roles:
description: Roles of user
items:
$ref: '#/definitions/schema.UserRole'
type: array
status:
description: Status of user (activated, freezed)
enum:
- activated
- freezed
type: string
username:
description: Username for login
maxLength: 64
type: string
required:
- name
- roles
- status
- username
type: object
schema.UserRole:
properties:
created_at:
description: Create time
type: string
id:
description: Unique ID
type: string
role_id:
description: From Role.ID
type: string
role_name:
description: From Role.Name
type: string
updated_at:
description: Update time
type: string
user_id:
description: From User.ID
type: string
type: object
util.ResponseResult:
properties:
data: {}
error:
$ref: '#/definitions/errors.Error'
success:
type: boolean
total:
type: integer
type: object
info:
contact: {}
description: 中海小程序
title: haibei
version: v1.0.0
paths:
/api/v1/activities:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Activity'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query activity list
tags:
- 活动模块
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ActivityForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Activity'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create activity record
tags:
- 活动模块
/api/v1/activities/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete activity record by ID
tags:
- 活动模块
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Activity'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get activity record by ID
tags:
- 活动模块
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ActivityForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update activity record by ID
tags:
- 活动模块
/api/v1/activity-details:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.ActivityDetail'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query activity detail list
tags:
- ActivityDetailAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ActivityDetailForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.ActivityDetail'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create activity detail record
tags:
- ActivityDetailAPI
/api/v1/activity-details/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete activity detail record by ID
tags:
- ActivityDetailAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.ActivityDetail'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get activity detail record by ID
tags:
- ActivityDetailAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ActivityDetailForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update activity detail record by ID
tags:
- ActivityDetailAPI
/api/v1/apps/banner:
get:
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Banner'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: 首页banner
tags:
- APP端
/api/v1/apps/bind:
post:
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: 小程序绑定手机号
tags:
- APP端
/api/v1/apps/login:
post:
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: 小程序登陆
tags:
- APP端
/api/v1/apps/sms/{phone}:
get:
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: 发送验证码
tags:
- APP端
/api/v1/areas:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Area'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query area list
tags:
- 区域模块
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.AreaForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Area'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create area record
tags:
- 区域模块
/api/v1/areas/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete area record by ID
tags:
- 区域模块
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Area'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get area record by ID
tags:
- 区域模块
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.AreaForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update area record by ID
tags:
- 区域模块
/api/v1/balances:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Balance'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query balance list
tags:
- 积分模块
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.BalanceForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Balance'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create balance record
tags:
- 积分模块
/api/v1/balances/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete balance record by ID
tags:
- 积分模块
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Balance'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get balance record by ID
tags:
- 积分模块
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.BalanceForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update balance record by ID
tags:
- 积分模块
/api/v1/banners:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Banner'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query banner list
tags:
- 首页轮播图模块
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.BannerForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Banner'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create banner record
tags:
- 首页轮播图模块
/api/v1/banners/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete banner record by ID
tags:
- 首页轮播图模块
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Banner'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get banner record by ID
tags:
- 首页轮播图模块
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.BannerForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update banner record by ID
tags:
- 首页轮播图模块
/api/v1/captcha/id:
get:
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Captcha'
type: object
summary: Get captcha ID
tags:
- LoginAPI
/api/v1/captcha/image:
get:
parameters:
- description: Captcha ID
in: query
name: id
required: true
type: string
- description: Reload captcha image (reload=1)
in: query
name: reload
type: number
produces:
- image/png
responses:
"200":
description: Captcha image
"404":
description: Not Found
schema:
$ref: '#/definitions/util.ResponseResult'
summary: Response captcha image
tags:
- LoginAPI
/api/v1/commons:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Common'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query common list
tags:
- CommonAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.CommonForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Common'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create common record
tags:
- CommonAPI
/api/v1/commons/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete common record by ID
tags:
- CommonAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Common'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get common record by ID
tags:
- CommonAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.CommonForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update common record by ID
tags:
- CommonAPI
/api/v1/companies:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Company'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query company list
tags:
- 项目模块
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.CompanyForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Company'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create company record
tags:
- 项目模块
/api/v1/companies/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete company record by ID
tags:
- 项目模块
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Company'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get company record by ID
tags:
- 项目模块
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.CompanyForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update company record by ID
tags:
- 项目模块
/api/v1/current/logout:
post:
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Logout system
tags:
- LoginAPI
/api/v1/current/menus:
get:
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Menu'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query current user menus based on the current user role
tags:
- LoginAPI
/api/v1/current/password:
put:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.UpdateLoginPassword'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Change current user password
tags:
- LoginAPI
/api/v1/current/refresh-token:
post:
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.LoginToken'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Refresh current access token
tags:
- LoginAPI
/api/v1/current/user:
get:
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.User'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get current user info
tags:
- LoginAPI
put:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.UpdateCurrentUser'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update current user info
tags:
- LoginAPI
/api/v1/customers:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Customer'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query customer list
tags:
- 客户模块
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.CustomerForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Customer'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create customer record
tags:
- 客户模块
/api/v1/customers/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete customer record by ID
tags:
- 客户模块
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Customer'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get customer record by ID
tags:
- 客户模块
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.CustomerForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update customer record by ID
tags:
- 客户模块
/api/v1/grades:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Grade'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query grade list
tags:
- 权益模块
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.GradeForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Grade'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create grade record
tags:
- 权益模块
/api/v1/grades/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete grade record by ID
tags:
- 权益模块
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Grade'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get grade record by ID
tags:
- 权益模块
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.GradeForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update grade record by ID
tags:
- 权益模块
/api/v1/loggers:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
- description: log level
in: query
name: level
type: string
- description: trace ID
in: query
name: traceID
type: string
- description: user name
in: query
name: userName
type: string
- description: log tag
in: query
name: tag
type: string
- description: log message
in: query
name: message
type: string
- description: start time
in: query
name: startTime
type: string
- description: end time
in: query
name: endTime
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Logger'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query logger list
tags:
- LoggerAPI
/api/v1/login:
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.LoginForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.LoginToken'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
summary: Login system with username and password
tags:
- LoginAPI
/api/v1/menus:
get:
parameters:
- description: Code path of menu (like xxx.xxx.xxx)
in: query
name: code
type: string
- description: Name of menu
in: query
name: name
type: string
- description: Whether to include menu resources
in: query
name: includeResources
type: boolean
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Menu'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query menu tree data
tags:
- MenuAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.MenuForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Menu'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create menu record
tags:
- MenuAPI
/api/v1/menus/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete menu record by ID
tags:
- MenuAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Menu'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get menu record by ID
tags:
- MenuAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.MenuForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update menu record by ID
tags:
- MenuAPI
/api/v1/notices:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Notice'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query notice list
tags:
- 公告模块
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.NoticeForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Notice'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create notice record
tags:
- 公告模块
/api/v1/notices/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete notice record by ID
tags:
- 公告模块
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Notice'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get notice record by ID
tags:
- 公告模块
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.NoticeForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update notice record by ID
tags:
- 公告模块
/api/v1/points:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Point'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query point list
tags:
- PointAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.PointForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Point'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create point record
tags:
- PointAPI
/api/v1/points/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete point record by ID
tags:
- PointAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Point'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get point record by ID
tags:
- PointAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.PointForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update point record by ID
tags:
- PointAPI
/api/v1/product-categories:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.ProductCategory'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query product category list
tags:
- 权益产品分类模块
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ProductCategoryForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.ProductCategory'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create product category record
tags:
- 权益产品分类模块
/api/v1/product-categories/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete product category record by ID
tags:
- 权益产品分类模块
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.ProductCategory'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get product category record by ID
tags:
- 权益产品分类模块
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ProductCategoryForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update product category record by ID
tags:
- 权益产品分类模块
/api/v1/product-orders:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.ProductOrder'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query product order list
tags:
- ProductOrderAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ProductOrderForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.ProductOrder'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create product order record
tags:
- ProductOrderAPI
/api/v1/product-orders/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete product order record by ID
tags:
- ProductOrderAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.ProductOrder'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get product order record by ID
tags:
- ProductOrderAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ProductOrderForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update product order record by ID
tags:
- ProductOrderAPI
/api/v1/products:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Product'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query product list
tags:
- 权益产品模块
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ProductForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Product'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create product record
tags:
- 权益产品模块
/api/v1/products/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete product record by ID
tags:
- 权益产品模块
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Product'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get product record by ID
tags:
- 权益产品模块
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ProductForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update product record by ID
tags:
- 权益产品模块
/api/v1/qeustion-details:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.QeustionDetail'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query qeustion detail list
tags:
- QeustionDetailAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.QeustionDetailForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.QeustionDetail'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create qeustion detail record
tags:
- QeustionDetailAPI
/api/v1/qeustion-details/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete qeustion detail record by ID
tags:
- QeustionDetailAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.QeustionDetail'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get qeustion detail record by ID
tags:
- QeustionDetailAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.QeustionDetailForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update qeustion detail record by ID
tags:
- QeustionDetailAPI
/api/v1/questionnaires:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Questionnaire'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query questionnaire list
tags:
- 问卷模块
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.QuestionnaireForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Questionnaire'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create questionnaire record
tags:
- 问卷模块
/api/v1/questionnaires/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete questionnaire record by ID
tags:
- 问卷模块
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Questionnaire'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get questionnaire record by ID
tags:
- 问卷模块
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.QuestionnaireForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update questionnaire record by ID
tags:
- 问卷模块
/api/v1/reception_center:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.ReceptionCenter'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query ReceptionCenter list
tags:
- 楼盘模块
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/api.CheckQrCodeStruct'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: check QrCode
tags:
- 楼盘模块
/api/v1/reception_center/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete ReceptionCenter record by ID
tags:
- 楼盘模块
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.ReceptionCenter'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get ReceptionCenter record by ID
tags:
- 楼盘模块
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.ReceptionCenterForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update ReceptionCenter record by ID
tags:
- 楼盘模块
/api/v1/reception_center/qr_code/{id}:
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
type: integer
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get ReceptionCenter QrCode by ID
tags:
- 楼盘模块
/api/v1/roles:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
- description: Display name of role
in: query
name: name
type: string
- description: Status of role (disabled, enabled)
in: query
name: status
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.Role'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query role list
tags:
- RoleAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.RoleForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Role'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create role record
tags:
- RoleAPI
/api/v1/roles/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete role record by ID
tags:
- RoleAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.Role'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get role record by ID
tags:
- RoleAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.RoleForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update role record by ID
tags:
- RoleAPI
/api/v1/users:
get:
parameters:
- default: 1
description: pagination index
in: query
name: current
required: true
type: integer
- default: 10
description: pagination size
in: query
name: pageSize
required: true
type: integer
- description: Username for login
in: query
name: username
type: string
- description: Name of user
in: query
name: name
type: string
- description: Status of user (activated, freezed)
in: query
name: status
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
items:
$ref: '#/definitions/schema.User'
type: array
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Query user list
tags:
- UserAPI
post:
parameters:
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.UserForm'
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.User'
type: object
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Create user record
tags:
- UserAPI
/api/v1/users/{id}:
delete:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Delete user record by ID
tags:
- UserAPI
get:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/util.ResponseResult'
- properties:
data:
$ref: '#/definitions/schema.User'
type: object
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Get user record by ID
tags:
- UserAPI
put:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
- description: Request body
in: body
name: body
required: true
schema:
$ref: '#/definitions/schema.UserForm'
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"400":
description: Bad Request
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Update user record by ID
tags:
- UserAPI
/api/v1/users/{id}/reset-pwd:
patch:
parameters:
- description: unique id
in: path
name: id
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/util.ResponseResult'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/util.ResponseResult'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/util.ResponseResult'
security:
- ApiKeyAuth: []
summary: Reset user password by ID
tags:
- UserAPI
securityDefinitions:
ApiKeyAuth:
in: header
name: Authorization
type: apiKey
swagger: "2.0"