Files
sundynix-plant-be/docs/swagger.yaml
T
2026-02-06 14:44:06 +08:00

4337 lines
96 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
definitions:
request.AlterClass:
properties:
id:
description: 植物id
type: string
ids:
description: 要关联的分类ids
items:
type: string
type: array
type: object
request.AlterRelatedLibrary:
properties:
id:
description: 植物id
type: string
ids:
description: 要关联的植物ids
items:
type: string
type: array
type: object
request.CareItem:
properties:
desc:
type: string
name:
type: string
period:
type: integer
type: object
request.CarePlan:
properties:
desc:
type: string
name:
description: 农事名称
type: string
period:
description: 周期
type: integer
type: object
request.CareSchedule:
properties:
careItems:
description: 养护项目
items:
$ref: '#/definitions/request.CareItem'
type: array
desc:
description: 描述
type: string
season:
description: 季节
type: string
sort:
description: 排序
type: integer
type: object
request.ChangePwd:
properties:
id:
type: string
newPwd:
type: string
type: object
request.CreateAddress:
properties:
detail:
type: string
isDefault:
type: integer
name:
type: string
phone:
type: string
type: object
request.CreateBadge:
properties:
categoryId:
type: string
countLimit:
description: 获取徽章需要完成的操作次数
type: integer
desc:
type: string
keyword:
type: string
name:
type: string
ossId:
type: string
required:
- countLimit
type: object
request.CreateBadgeCategory:
properties:
desc:
type: string
name:
type: string
required:
- name
type: object
request.CreateClaimPlant:
properties:
content:
type: string
libraryId:
description: 百科id
type: string
name:
type: string
ossIds:
items:
type: string
type: array
points:
type: integer
postage:
description: 邮费 单位(分)
type: integer
stock:
description: 库存
type: integer
tag:
type: string
videoUrl:
type: string
type: object
request.CreateClassification:
properties:
name:
description: 分类名称
type: string
ossId:
description: 图片id
type: string
tag:
description: 标签
type: string
required:
- name
type: object
request.CreateComment:
properties:
content:
description: 评论内容
type: string
parentId:
description: 父级评论id" 默认为0
type: string
postId:
description: 帖子id
type: string
rootId:
description: 根评论id 默认为0 如评论1 评论2 评论3 1是根评论 2是1的子评论 3是2的子评论 那么2和3的rootId都是1的主键id
type: string
required:
- content
- parentId
- postId
- rootId
type: object
request.CreateGrowRecord:
properties:
content:
type: string
desc:
type: string
name:
type: string
ossIds:
items:
type: string
type: array
plantId:
type: string
tag:
type: string
required:
- plantId
type: object
request.CreateInvitationConfig:
properties:
codeExpireDays:
description: 邀请码有效期(天)
type: integer
codeLength:
description: 邀请码长度
type: integer
enableAutoAward:
description: 是否自动发放积分
type: integer
isActive:
description: 是否启用
type: integer
maxInvitesPerDay:
description: 每日最大邀请奖励次数
type: integer
maxPointsPerUser:
description: 单用户最大邀请奖励积分
type: integer
name:
description: 配置名称
type: string
pointsPerInvite:
description: 每成功邀请奖励积分
type: integer
type: object
request.CreateLibrary:
properties:
aliases:
description: 别名
type: string
careSchedule:
description: 养护计划
items:
$ref: '#/definitions/request.CareSchedule'
type: array
classIds:
description: 分类id
items:
type: string
type: array
difficulty:
description: 种植难度 1-5级
type: integer
distributionArea:
description: 分布区域
type: string
flowerDiameter:
description: 花直径(cm)
type: integer
floweringColor:
description: 花色
type: string
floweringPeriod:
description: 开花特征
type: string
floweringShape:
description: 花形
type: string
foliageColor:
description: 叶色
type: string
foliageShape:
description: 叶形
type: string
foliageType:
description: 植物特征
type: string
fruit:
description:
type: string
genus:
description:
type: string
growthHabit:
description: 生长习性
type: string
height:
description: 高度(cm)
type: integer
isHot:
description: 是否热门
type: integer
latinName:
description: 拉丁名
type: string
lifeCycle:
description: 生命周期
type: string
lightIntensity:
description: 光照强度
type: string
lightType:
description: 光照类型(直射,散射等)
type: string
name:
description: 基本信息
type: string
optimalTempPeriod:
description: 最佳温度区间
type: string
ossIds:
description: 图片
items:
type: string
type: array
pestsDiseases:
description: 常见病虫害
type: string
relatedLibraryIds:
description: 相关推荐 library
items:
type: string
type: array
reproductionMethod:
description: 繁殖方法
type: string
stem:
description:
type: string
tag:
description: 标签
type: string
required:
- name
type: object
request.CreateMyPlant:
properties:
carePlans:
description: 养护计划
items:
$ref: '#/definitions/request.CarePlan'
type: array
name:
description: 植物名称
type: string
ossIds:
description: 图片
items:
type: string
type: array
placement:
description: 摆放位置
type: string
plantTime:
description: 种植时间
type: string
plantingMaterial:
description: 植料(即土的材质)
type: string
potMaterial:
description: 花盆材质
type: string
potSize:
description: 花盆大小 如直径 20cm × 高度 18cm
type: string
sunlight:
description: 光照条件如每日12小时
type: string
type: object
request.CreatePost:
properties:
content:
description: 内容
type: string
location:
description: 位置
type: string
ossIds:
description: 图片id[]
items:
type: string
type: array
title:
description: 标题 必须
type: string
type: object
request.CreateQrcode:
properties:
name:
type: string
ossId:
type: string
url:
type: string
type: object
request.DeleteClass:
properties:
id:
description: 植物id
type: string
ids:
description: 要取消关联的分类ids
items:
type: string
type: array
type: object
request.DeleteOss:
properties:
id:
description: 数据主键
type: string
ossIds:
items:
type: string
type: array
required:
- id
- ossIds
type: object
request.DeleteRelatedLibrary:
properties:
id:
description: 植物id
type: string
ids:
description: 要取消关联的植物ids
items:
type: string
type: array
type: object
request.GetClientList:
properties:
clientId:
type: string
current:
description: 页码
type: integer
keyword:
description: 关键字
type: string
name:
type: string
pageSize:
description: 每页大小
type: integer
type: object
request.GetMenuTree:
properties:
category:
type: integer
parentId:
type: string
type: object
request.GetOssFileList:
properties:
current:
description: 页码
type: integer
keyword:
description: 关键字
type: string
name:
type: string
pageSize:
description: 每页大小
type: integer
type: object
request.GetRoleList:
properties:
code:
type: string
current:
description: 页码
type: integer
keyword:
description: 关键字
type: string
name:
type: string
pageSize:
description: 每页大小
type: integer
type: object
request.GetUserList:
properties:
account:
type: string
current:
description: 页码
type: integer
keyword:
description: 关键字
type: string
pageSize:
description: 每页大小
type: integer
phone:
type: string
type: object
request.GrantMenu:
properties:
menuIds:
items:
type: string
type: array
roleId:
type: string
type: object
request.GrantRole:
properties:
roleIds:
items:
type: string
type: array
userId:
type: string
type: object
request.IdsReq:
properties:
ids:
items:
type: string
type: array
type: object
request.LibraryList:
properties:
isHot:
description: 是否热门 0否 1是
type: integer
name:
description: 植物名称
type: string
type: object
request.LibraryPage:
properties:
classId:
description: 分类id
type: string
current:
description: 页码
type: integer
isHot:
description: 是否热门 0否 1是
type: integer
keyword:
description: 关键字
type: string
name:
description: 植物名称
type: string
pageSize:
description: 每页大小
type: integer
type: object
request.Login:
properties:
account:
type: string
captcha:
type: string
captchaId:
type: string
password:
type: string
type: object
request.MakeCare:
properties:
id:
description: 今日养护id(任务id
type: string
remark:
description: 备注
type: string
status:
description: 状态 1:未完成 2:完成 3:跳过 4:逾期
type: integer
required:
- id
- status
type: object
request.OrderPage:
properties:
current:
description: 页码
type: integer
isShipped:
description: 是否发货 0 1
type: integer
keyword:
description: 关键字
type: string
pageSize:
description: 每页大小
type: integer
status:
description: 支付状态 1.SUCCESS 2.REFUND 3.NOTPAY 4.CLOSED
type: integer
type: object
request.PageBadge:
properties:
categoryId:
type: string
current:
description: 页码
type: integer
keyword:
description: 关键字
type: string
name:
type: string
pageSize:
description: 每页大小
type: integer
type: object
request.PageCategory:
properties:
current:
description: 页码
type: integer
keyword:
description: 关键字
type: string
name:
type: string
pageSize:
description: 每页大小
type: integer
type: object
request.PageClaimPlant:
properties:
current:
description: 页码
type: integer
keyword:
description: 关键字
type: string
name:
type: string
pageSize:
description: 每页大小
type: integer
type: object
request.PageGrowRecord:
properties:
current:
description: 页码
type: integer
id:
description: 植物id
type: string
keyword:
description: 关键字
type: string
pageSize:
description: 每页大小
type: integer
type: object
request.PageInfo:
properties:
current:
description: 页码
type: integer
keyword:
description: 关键字
type: string
pageSize:
description: 每页大小
type: integer
type: object
request.PagePlant:
properties:
current:
description: 页码
type: integer
keyword:
description: 关键字
type: string
name:
type: string
pageSize:
description: 每页大小
type: integer
type: object
request.PostPage:
properties:
current:
description: 页码
type: integer
hasReviewed:
description: 是否审核通过
type: integer
keyword:
description: 关键字
type: string
pageSize:
description: 每页大小
type: integer
title:
description: 标题
type: string
type: object
request.UnionLibrary:
properties:
id:
description: 植物id
type: string
libraryId:
description: 百科植物id
type: string
type: object
request.UpdateAddress:
properties:
detail:
type: string
id:
type: string
isDefault:
type: integer
name:
type: string
phone:
type: string
required:
- id
type: object
request.UpdateBadge:
properties:
categoryId:
type: string
countLimit:
description: 获取徽章需要完成的操作次数
type: integer
desc:
type: string
id:
type: string
keyword:
type: string
name:
type: string
ossId:
type: string
required:
- countLimit
- id
type: object
request.UpdateBadgeCategory:
properties:
desc:
type: string
id:
type: string
name:
type: string
required:
- id
type: object
request.UpdateCarePlan:
properties:
id:
description: 养护计划id
type: string
period:
description: 周期
type: integer
required:
- id
- period
type: object
request.UpdateClaimPlant:
properties:
content:
type: string
id:
type: string
libraryId:
description: 百科id
type: string
name:
type: string
points:
type: integer
postage:
description: 邮费 单位(分)
type: integer
stock:
description: 库存
type: integer
tag:
type: string
videoUrl:
type: string
required:
- id
type: object
request.UpdateClassification:
properties:
id:
type: string
name:
description: 分类名称
type: string
ossId:
description: 图片id
type: string
tag:
description: 标签
type: string
required:
- id
type: object
request.UpdateInvitationConfig:
properties:
codeExpireDays:
description: 邀请码有效期(天)
type: integer
codeLength:
description: 邀请码长度
type: integer
enableAutoAward:
description: 是否自动发放积分
type: integer
id:
type: string
isActive:
description: 是否启用
type: integer
maxInvitesPerDay:
description: 每日最大邀请奖励次数
type: integer
maxPointsPerUser:
description: 单用户最大邀请奖励积分
type: integer
name:
description: 配置名称
type: string
pointsPerInvite:
description: 每成功邀请奖励积分
type: integer
required:
- id
type: object
request.UpdateLibrary:
properties:
aliases:
description: 别名
type: string
difficulty:
description: 种植难度 1-5级
type: integer
distributionArea:
description: 分布区域
type: string
flowerDiameter:
description: 花直径(cm)
type: integer
floweringColor:
description: 花色
type: string
floweringPeriod:
description: 开花特征
type: string
floweringShape:
description: 花形
type: string
foliageColor:
description: 叶色
type: string
foliageShape:
description: 叶形
type: string
foliageType:
description: 植物特征
type: string
fruit:
description:
type: string
genus:
description:
type: string
growthHabit:
description: 生长习性
type: string
height:
description: 高度(cm)
type: integer
id:
type: string
isHot:
description: 是否热门
type: integer
latinName:
description: 拉丁名
type: string
lifeCycle:
description: 生命周期
type: string
lightIntensity:
description: 光照强度
type: string
lightType:
description: 光照类型(直射,散射等)
type: string
name:
description: 名称
type: string
optimalTempPeriod:
description: 温度
type: string
ossId:
description: ossId
type: string
pestsDiseases:
description: 常见病虫害
type: string
stem:
description:
type: string
tag:
description: 标签
type: string
required:
- id
type: object
request.UpdateMyPlant:
properties:
id:
type: string
name:
description: 植物名称
type: string
placement:
description: 摆放位置
type: string
plantingMaterial:
description: 植料(即土的材质)
type: string
potMaterial:
description: 花盆材质
type: string
potSize:
description: 花盆大小 如直径 20cm × 高度 18cm
type: string
sunlight:
description: 光照条件如每日12小时
type: string
required:
- id
type: object
request.UpdatePost:
properties:
content:
description: 内容
type: string
id:
type: string
title:
description: 标题
type: string
required:
- id
type: object
request.UpdateQrcode:
properties:
id:
type: string
name:
type: string
url:
type: string
required:
- id
type: object
request.UploadFile:
properties:
id:
description: 数据主键
type: string
ossIds:
description: ossId
type: string
required:
- id
- ossIds
type: object
request.UploadOss:
properties:
id:
description: 数据主键
type: string
ossIds:
description: ossIds
items:
type: string
type: array
required:
- id
- ossIds
type: object
response.CaptchaRes:
properties:
captcha:
type: string
captchaId:
type: string
type: object
response.LoginResponse:
properties:
expiresAt:
type: integer
token:
type: string
user:
$ref: '#/definitions/system.User'
type: object
response.PageResult:
properties:
list: {}
page:
type: integer
pageSize:
type: integer
total:
type: integer
type: object
response.Response:
properties:
code:
type: integer
data: {}
msg:
type: string
type: object
system.Client:
properties:
activeTimeout:
type: integer
additionalInfo:
type: string
clientId:
type: string
createdAt:
type: string
createdAtStr:
type: string
grantType:
type: string
id:
description: 主键ID
type: string
name:
type: string
updatedAt:
type: string
type: object
system.Menu:
properties:
category:
type: integer
children:
items:
$ref: '#/definitions/system.Menu'
type: array
code:
type: string
createdAt:
type: string
createdAtStr:
type: string
icon:
type: string
id:
description: 主键ID
type: string
locale:
type: string
name:
type: string
parentId:
type: string
permission:
type: string
sort:
type: integer
title:
type: string
updatedAt:
type: string
type: object
system.Oss:
properties:
createdAt:
type: string
createdAtStr:
type: string
height:
type: integer
id:
description: 主键ID
type: string
key:
type: string
md5:
type: string
name:
type: string
suffix:
type: string
tag:
type: string
updatedAt:
type: string
url:
type: string
width:
type: integer
type: object
system.Role:
properties:
code:
type: string
createdAt:
type: string
createdAtStr:
type: string
id:
description: 主键ID
type: string
menus:
items:
$ref: '#/definitions/system.Menu'
type: array
name:
type: string
sort:
type: integer
updatedAt:
type: string
type: object
system.User:
properties:
account:
type: string
avatar:
$ref: '#/definitions/system.Oss'
avatarId:
type: string
clientId:
type: string
createdAt:
type: string
createdAtStr:
type: string
id:
description: 主键ID
type: string
miniOpenId:
description: 植趣小程序openid
type: string
name:
type: string
phone:
type: string
saOpenId:
description: 植趣服务号openid
type: string
sessionKey:
type: string
tenantId:
type: string
unionId:
type: string
updatedAt:
type: string
type: object
info:
contact: {}
description: 使用gin + gorm进行极速开发的全栈开发基础平台
title: Swagger API接口文档
version: v1.0.0
paths:
/auth/captcha:
get:
produces:
- application/json
responses:
"200":
description: 获取验证码
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.CaptchaRes'
type: object
summary: 获取验证码
tags:
- 登录相关
/auth/getLocation:
get:
parameters:
- description: longitude
in: query
name: longitude
required: true
type: string
- description: latitude
in: query
name: latitude
required: true
type: string
produces:
- application/json
responses: {}
summary: 获取位置信息
tags:
- 登录相关
/auth/getPhone:
get:
parameters:
- description: code
in: query
name: code
required: true
type: string
- description: openId
in: query
name: openId
required: true
type: string
produces:
- application/json
responses: {}
summary: 获取手机号
tags:
- 登录相关
/auth/getWeather:
get:
parameters:
- description: adcode
in: query
name: adcode
required: true
type: string
produces:
- application/json
responses: {}
summary: 获取天气信息
tags:
- 登录相关
/auth/login:
post:
consumes:
- application/json
parameters:
- description: 用户名, 密码, 验证码,验证码id
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.Login'
produces:
- application/json
responses:
"200":
description: 登录成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
summary: pc登录
tags:
- 登录相关
/auth/logout:
get:
produces:
- application/json
responses:
"200":
description: 登出成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: pc登出
tags:
- 登录相关
/auth/miniLogin:
get:
parameters:
- description: code
in: query
name: code
required: true
type: string
produces:
- application/json
responses:
"200":
description: 小程序登录
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.LoginResponse'
type: object
summary: 小程序登录
tags:
- 登录相关
/badge/add:
post:
consumes:
- application/json
parameters:
- description: 添加
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.CreateBadge'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"添加成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 添加
tags:
- 徽章
/badge/all:
get:
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
summary: 获取所有无分页
tags:
- 徽章
/badge/class/add:
post:
consumes:
- application/json
parameters:
- description: 添加分类
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.CreateBadgeCategory'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"添加成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 添加分类
tags:
- 徽章
/badge/class/delete:
post:
consumes:
- application/json
parameters:
- description: 删除分类
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.IdsReq'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"删除成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除分类
tags:
- 徽章
/badge/class/detail:
get:
parameters:
- description: id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 分类详情
tags:
- 徽章
/badge/class/list:
post:
consumes:
- application/json
parameters:
- description: 分类列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.PageCategory'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 分类列表
tags:
- 徽章
/badge/class/update:
post:
consumes:
- application/json
parameters:
- description: 修改分类
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.UpdateBadgeCategory'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"修改成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 修改分类
tags:
- 徽章
/badge/delete:
post:
consumes:
- application/json
parameters:
- description: 删除ByIds
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.IdsReq'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"删除成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除ByIds
tags:
- 徽章
/badge/detail:
get:
parameters:
- description: id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 详情
tags:
- 徽章
/badge/list:
post:
consumes:
- application/json
parameters:
- description: 获取列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.PageBadge'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 获取列表有分页
tags:
- 徽章
/badge/listByKeyword:
get:
parameters:
- description: keyword
in: query
name: keyword
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 获取列表byKeyword无分页
tags:
- 徽章
/badge/my/all:
get:
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 我的所有徽章
tags:
- 徽章
/badge/my/detail:
get:
parameters:
- description: id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 我的徽章详情
tags:
- 徽章
/badge/my/list:
post:
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 我的徽章
tags:
- 徽章
/badge/update:
post:
consumes:
- application/json
parameters:
- description: 修改
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.UpdateBadge'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"修改成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 修改
tags:
- 徽章
/badge/uploadImg:
post:
consumes:
- application/json
parameters:
- description: 上传图片
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.UploadFile'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"上传成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 上传图片
tags:
- 徽章
/claim/add:
post:
consumes:
- application/json
parameters:
- description: 添加
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.CreateClaimPlant'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"添加成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 配置植物
tags:
- 兑换植物
/claim/cancelUnion:
post:
parameters:
- description: id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"取消关联成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 取消关联百科植物
tags:
- 兑换植物
/claim/claim:
get:
consumes:
- application/json
parameters:
- description: id
in: query
name: id
required: true
type: string
- description: addressId
in: query
name: addressId
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"认养成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 认养
tags:
- 兑换植物
/claim/delete:
post:
consumes:
- application/json
parameters:
- description: 删除
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.IdsReq'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"删除成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除ByIds
tags:
- 兑换植物
/claim/detail:
get:
parameters:
- description: id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 详情
tags:
- 兑换植物
/claim/list:
post:
consumes:
- application/json
parameters:
- description: 获取列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.PageClaimPlant'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 获取列表
tags:
- 兑换植物
/claim/myClaims:
get:
consumes:
- application/json
parameters:
- description: 获取列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.PageClaimPlant'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 我的认养
tags:
- 兑换植物
/claim/unionLibrary:
post:
consumes:
- application/json
parameters:
- description: 关联
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.UnionLibrary'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"关联成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 关联百科植物
tags:
- 兑换植物
/claim/update:
post:
consumes:
- application/json
parameters:
- description: 修改
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.UpdateClaimPlant'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"修改成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 修改植物
tags:
- 兑换植物
/class/add:
post:
consumes:
- application/json
parameters:
- description: 新增分类
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.CreateClassification'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"新增成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 新增分类
tags:
- 植物库分类
/class/delete:
post:
consumes:
- application/json
parameters:
- description: 删除分类
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.IdsReq'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"删除成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除分类
tags:
- 植物库分类
/class/detail:
get:
parameters:
- description: 分类id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 分类详情
tags:
- 植物库分类
/class/list:
post:
consumes:
- application/json
parameters:
- description: 分类列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.PageInfo'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 分类列表
tags:
- 植物库分类
/class/update:
post:
consumes:
- application/json
parameters:
- description: 修改分类
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.UpdateClassification'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"修改成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 修改分类
tags:
- 植物库分类
/client/delete:
post:
consumes:
- application/json
parameters:
- description: ids
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.IdsReq'
produces:
- application/json
responses:
"200":
description: 删除client
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 删除client
tags:
- 客户端管理
/client/detail:
get:
description: id获取详情
parameters:
- description: id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 获取client详情
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/system.Client'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取client详情
tags:
- 客户端管理
/client/getClientList:
post:
consumes:
- application/json
parameters:
- description: client
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.GetClientList'
produces:
- application/json
responses:
"200":
description: 获取client列表
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.PageResult'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取client列表
tags:
- 客户端管理
/client/save:
post:
consumes:
- application/json
parameters:
- description: client
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.Client'
produces:
- application/json
responses:
"200":
description: 创建client
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 创建client
tags:
- 客户端管理
/client/update:
post:
consumes:
- application/json
parameters:
- description: client
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.Client'
produces:
- application/json
responses:
"200":
description: 更新client
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 更新client
tags:
- 客户端管理
/comment/add:
post:
consumes:
- application/json
parameters:
- description: 添加评论
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.CreateComment'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"添加成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 发表评论
tags:
- 帖子评论
/comment/delete:
delete:
consumes:
- application/json
parameters:
- description: 删除评论
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.IdsReq'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"删除成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除评论
tags:
- 帖子评论
/config/invitation/add:
post:
consumes:
- application/json
parameters:
- description: 配置邀请码
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.CreateInvitationConfig'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"配置成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 配置邀请码
tags:
- 配置中心
/config/invitation/delete:
post:
consumes:
- application/json
parameters:
- description: 删除邀请码
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.IdsReq'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"删除成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除邀请码配置
tags:
- 配置中心
/config/invitation/detail:
get:
parameters:
- description: 邀请码id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 获取邀请码配置
tags:
- 配置中心
/config/invitation/list:
post:
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 获取邀请码列表
tags:
- 配置中心
/config/invitation/update:
post:
consumes:
- application/json
parameters:
- description: 更新邀请码
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.UpdateInvitationConfig'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"更新成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 更新邀请码配置
tags:
- 配置中心
/config/qrcode/add:
post:
consumes:
- application/json
parameters:
- description: 配置二维码
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.CreateQrcode'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"配置成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 配置二维码
tags:
- 配置中心
/config/qrcode/delete:
post:
parameters:
- description: 二维码id
in: body
name: ids
required: true
schema:
$ref: '#/definitions/request.IdsReq'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"删除成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除二维码
tags:
- 配置中心
/config/qrcode/detail:
get:
parameters:
- description: 二维码id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 获取二维码详情
tags:
- 配置中心
/config/qrcode/list:
post:
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 获取二维码
tags:
- 配置中心
/config/qrcode/update:
post:
consumes:
- application/json
parameters:
- description: 更新二维码
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.UpdateQrcode'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"更新成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 更新二维码
tags:
- 配置中心
/config/qrcode/uploadImg:
post:
consumes:
- application/json
parameters:
- description: 上传二维码图片
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.UploadFile'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"上传成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 上传二维码图片
tags:
- 配置中心
/library/add:
post:
consumes:
- application/json
parameters:
- description: 新增植物库
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.CreateLibrary'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 新增植物库
tags:
- 植物库
/library/all:
post:
consumes:
- application/json
parameters:
- description: 获取所有植物库列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.LibraryList'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取所有植物库列表
tags:
- 植物库
/library/alterClass:
post:
consumes:
- application/json
parameters:
- description: 修改分类
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.AlterClass'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 修改分类
tags:
- 植物库
/library/delete:
post:
consumes:
- application/json
parameters:
- description: 删除植物库
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.IdsReq'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 删除植物库
tags:
- 植物库
/library/deleteClass:
post:
consumes:
- application/json
parameters:
- description: 取消关联分类
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.DeleteClass'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 取消关联分类
tags:
- 植物库
/library/deleteImg:
post:
consumes:
- application/json
parameters:
- description: 上传图片
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.DeleteOss'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 上传图片
tags:
- 植物库
/library/deleteRelateLibrary:
post:
consumes:
- application/json
parameters:
- description: 删除关联
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.DeleteRelatedLibrary'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 删除关联植物
tags:
- 植物库
/library/detail:
get:
parameters:
- description: 获取植物库详情
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取植物库详情
tags:
- 植物库
/library/hot:
post:
consumes:
- application/json
parameters:
- description: 设置热门
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.IdsReq'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 设置或取消热门
tags:
- 植物库
/library/page:
post:
consumes:
- application/json
parameters:
- description: 获取植物库列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.LibraryPage'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取植物库列表
tags:
- 植物库
/library/reateLibrary:
post:
consumes:
- application/json
parameters:
- description: 添加关联
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.AlterRelatedLibrary'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 添加关联植物
tags:
- 植物库
/library/update:
post:
consumes:
- application/json
parameters:
- description: 修改植物库
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.UpdateLibrary'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 修改植物库
tags:
- 植物库
/library/uploadImg:
post:
consumes:
- application/json
parameters:
- description: 上传图片
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.UploadOss'
produces:
- application/json
responses:
"200":
description: OK
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 上传图片
tags:
- 植物库
/menu/delete:
get:
description: 删除menu
parameters:
- description: id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 详情
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 删除menu
tags:
- 菜单管理
/menu/detail:
get:
description: id获取详情
parameters:
- description: id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 详情
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/system.Menu'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取menu详情
tags:
- 菜单管理
/menu/getAllMenuTree:
post:
consumes:
- application/json
parameters:
- description: 菜单信息
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.GetMenuTree'
produces:
- application/json
responses:
"200":
description: 获取所有菜单树
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
items:
$ref: '#/definitions/system.Menu'
type: array
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取所有菜单树
tags:
- 菜单管理
/menu/getUserMenuTree:
get:
produces:
- application/json
responses:
"200":
description: 用户菜单数据
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
items:
$ref: '#/definitions/system.Menu'
type: array
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 用户菜单数据
tags:
- 菜单管理
/menu/route:
get:
produces:
- application/json
responses:
"200":
description: 用户route
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
items:
$ref: '#/definitions/system.Menu'
type: array
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 用户路由
tags:
- 菜单管理
/menu/save:
post:
consumes:
- application/json
parameters:
- description: menu
in: body
name: data
schema:
$ref: '#/definitions/system.Menu'
produces:
- application/json
responses:
"200":
description: 新建菜单/按钮
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 新增菜单
tags:
- 菜单管理
/menu/update:
post:
consumes:
- application/json
parameters:
- description: menu
in: body
name: data
schema:
$ref: '#/definitions/system.Menu'
produces:
- application/json
responses:
"200":
description: 更新菜单
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 更新菜单
tags:
- 菜单管理
/ocr/base64:
post:
consumes:
- multipart/form-data
parameters:
- description: 植物识别
in: formData
name: file
required: true
type: file
produces:
- application/json
responses:
"200":
description: 文件OCR
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: base64植物识别
tags:
- 识别相关
/ocr/url:
get:
consumes:
- multipart/form-data
parameters:
- description: id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 文件OCR
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: url植物识别
tags:
- 识别相关
/order/delete:
post:
consumes:
- application/json
parameters:
- description: 删除订单
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.IdsReq'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除订单
tags:
- 订单
/order/detail:
get:
parameters:
- description: id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 订单详情
tags:
- 订单
/order/export:
post:
parameters:
- description: 页码
in: query
name: current
type: integer
- description: 是否发货 0 1
in: query
name: isShipped
type: integer
- description: 关键字
in: query
name: keyword
type: string
- description: 每页大小
in: query
name: pageSize
type: integer
- description: 支付状态 1.SUCCESS 2.REFUND 3.NOTPAY 4.CLOSED
in: query
name: status
type: integer
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 导出订单
tags:
- 订单
/order/page:
post:
consumes:
- application/json
parameters:
- description: 获取列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.OrderPage'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 订单列表
tags:
- 订单
/order/ship:
post:
consumes:
- application/json
parameters:
- description: 发货
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.IdsReq'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 发货
tags:
- 订单
/oss/delete:
post:
consumes:
- application/json
parameters:
- description: 批量删除文件
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.IdsReq'
produces:
- application/json
responses:
"200":
description: 删除文件
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 删除文件
tags:
- 文件相关
/oss/detail:
get:
parameters:
- description: 文件id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 文件详情
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 文件详情
tags:
- 文件相关
/oss/getFileList:
post:
consumes:
- application/json
parameters:
- description: 文件列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.GetOssFileList'
produces:
- application/json
responses:
"200":
description: 文件列表
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 文件列表
tags:
- 文件相关
/oss/upload:
post:
consumes:
- multipart/form-data
parameters:
- description: 上传文件
in: formData
name: file
required: true
type: file
produces:
- application/json
responses:
"200":
description: 上传文件
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 文件上传
tags:
- 文件相关
/pay/prePay:
get:
consumes:
- application/json
parameters:
- description: 支付
in: query
name: orderId
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"支付成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 支付
tags:
- 微信支付
/personal/address/add:
post:
consumes:
- application/json
parameters:
- description: 添加地址
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.CreateAddress'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"添加成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 添加地址
tags:
- 个人中心
/personal/address/delete:
post:
consumes:
- application/json
parameters:
- description: 删除地址
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.IdsReq'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"删除成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除地址
tags:
- 个人中心
/personal/address/detail:
get:
parameters:
- description: id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 地址详情
tags:
- 个人中心
/personal/address/list:
get:
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 地址列表
tags:
- 个人中心
/personal/address/setDefault:
post:
consumes:
- application/json
parameters:
- description: id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"设置成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 设置默认地址
tags:
- 个人中心
/personal/address/update:
post:
consumes:
- application/json
parameters:
- description: 修改地址
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.UpdateAddress'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"修改成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 修改地址
tags:
- 个人中心
/personal/centerCount:
get:
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 个人中心统计
tags:
- 个人中心
/personal/inviteCode/accept:
get:
parameters:
- description: inviteCode
in: query
name: inviteCode
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"接受成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 接受邀请
tags:
- 个人中心
/personal/inviteCode/code:
get:
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"生成成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 生成邀请码
tags:
- 个人中心
/personal/inviteCode/records:
post:
consumes:
- application/json
parameters:
- description: 分页参数
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.PageInfo'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 邀请记录
tags:
- 个人中心
/plant/add:
post:
consumes:
- application/json
parameters:
- description: 创建植物
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.CreateMyPlant'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"添加成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 添加植物
tags:
- 我的植物
/plant/carePlant:
get:
parameters:
- description: id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"操作成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 立即养护
tags:
- 我的植物
/plant/careRecords:
get:
parameters:
- description: id
in: query
name: id
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"操作成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 养护记录
tags:
- 我的植物
/plant/delete:
post:
consumes:
- application/json
parameters:
- description: 删除ByIds
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.IdsReq'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"删除成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除ByIds
tags:
- 我的植物
/plant/deleteImg:
post:
consumes:
- application/json
parameters:
- description: 删除图片
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.DeleteOss'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"删除成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除图片
tags:
- 我的植物
/plant/detail:
get:
parameters:
- description: id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 获取ById
tags:
- 我的植物
/plant/grow/addRecord:
post:
consumes:
- application/json
parameters:
- description: 添加成长记录
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.CreateGrowRecord'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"操作成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 添加成长记录
tags:
- 我的植物
/plant/grow/recordDetail:
get:
parameters:
- description: id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"操作成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 成长记录详情
tags:
- 我的植物
/plant/grow/recordList:
post:
consumes:
- application/json
parameters:
- description: 成长记录列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.PageGrowRecord'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"操作成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 成长记录列表
tags:
- 我的植物
/plant/makeCare:
post:
consumes:
- application/json
parameters:
- description: 养护操作
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.MakeCare'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"操作成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 根据任务完成养护
tags:
- 我的植物
/plant/myPlants:
get:
parameters:
- description: name
in: query
name: name
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 植物列表不分页
tags:
- 我的植物
/plant/needCare:
get:
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"操作成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 待养护
tags:
- 我的植物
/plant/page:
post:
consumes:
- application/json
parameters:
- description: 获取植物列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.PagePlant'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 植物列表
tags:
- 我的植物
/plant/taskProgress:
get:
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"操作成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 任务进度
tags:
- 我的植物
/plant/todayCare:
get:
responses:
"200":
description: '{"success":true,"data":{},"msg":"操作成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 今日养护
tags:
- 我的植物
/plant/update:
post:
consumes:
- application/json
parameters:
- description: 修改植物
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.UpdateMyPlant'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"修改成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 修改植物
tags:
- 我的植物
/plant/updateCarePlan:
post:
consumes:
- application/json
parameters:
- description: 修改养护周期
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.UpdateCarePlan'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"修改成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 修改养护事项周期
tags:
- 我的植物
/plant/uploadImg:
post:
consumes:
- application/json
parameters:
- description: 上传图片
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.UploadOss'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"上传成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 上传图片
tags:
- 我的植物
/post/add:
post:
consumes:
- application/json
parameters:
- description: 创建帖子
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.CreatePost'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"添加成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 发布
tags:
- 帖子
/post/cancelLike:
get:
parameters:
- description: 帖子id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"取消点赞成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 取消点赞
tags:
- 帖子
/post/delete:
post:
consumes:
- application/json
parameters:
- description: 删除帖子
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.IdsReq'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"删除成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除帖子
tags:
- 帖子
/post/deleteImg:
post:
consumes:
- application/json
parameters:
- description: 删除帖子图片
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.DeleteOss'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"删除成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 删除帖子图片
tags:
- 帖子
/post/detail:
get:
parameters:
- description: 帖子id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 帖子详情
tags:
- 帖子
/post/like:
get:
parameters:
- description: 帖子id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"点赞成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 点赞帖子
tags:
- 帖子
/post/myPosts:
post:
consumes:
- application/json
parameters:
- description: 页码
in: query
name: current
type: integer
- description: 关键字
in: query
name: keyword
type: string
- description: 每页大小
in: query
name: pageSize
type: integer
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 我的帖子
tags:
- 帖子
/post/page:
post:
consumes:
- application/json
parameters:
- description: 帖子列表
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.PostPage'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"获取成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 帖子列表
tags:
- 帖子
/post/update:
post:
consumes:
- application/json
parameters:
- description: 修改帖子
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.UpdatePost'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"修改成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 修改帖子
tags:
- 帖子
/post/uploadImg:
post:
consumes:
- application/json
parameters:
- description: 上传帖子图片
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.UploadOss'
produces:
- application/json
responses:
"200":
description: '{"success":true,"data":{},"msg":"上传成功"}'
schema:
type: string
security:
- ApiKeyAuth: []
summary: 上传帖子图片
tags:
- 帖子
/role/delete:
post:
consumes:
- application/json
description: 删除角色
parameters:
- description: 批量删除角色
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.IdsReq'
produces:
- application/json
responses:
"200":
description: 删除角色
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
summary: 删除角色
tags:
- 角色管理
/role/detail:
get:
parameters:
- description: id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 角色详情
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/system.Role'
type: object
security:
- ApiKeyAuth: []
summary: 角色详情
tags:
- 角色管理
/role/getRoleList:
post:
consumes:
- application/json
description: 获取角色列表
parameters:
- description: 页码, 每页大小, 搜索条件
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.GetRoleList'
produces:
- application/json
responses:
"200":
description: 获取角色列表,返回包括列表,总数,页码,每页大小
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.PageResult'
msg:
type: string
type: object
summary: 获取角色列表
tags:
- 角色管理
/role/grantMenu:
post:
consumes:
- application/json
parameters:
- description: 授权菜单给角色
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.GrantMenu'
produces:
- application/json
responses:
"200":
description: 授权菜单给角色
schema:
$ref: '#/definitions/response.Response'
security:
- ApiKeyAuth: []
summary: 授权菜单给角色
tags:
- 角色管理
/role/save:
post:
consumes:
- application/json
parameters:
- description: 角色信息
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.Role'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
security:
- ApiKeyAuth: []
summary: 创建角色
tags:
- 角色管理
/role/update:
post:
consumes:
- application/json
parameters:
- description: 角色ID
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.Role'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/response.Response'
security:
- ApiKeyAuth: []
summary: 修改角色
tags:
- 角色管理
/user/changePassword:
post:
consumes:
- application/json
description: 修改密码
parameters:
- description: 用户id
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.ChangePwd'
produces:
- application/json
responses:
"200":
description: 修改密码成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/system.User'
type: object
security:
- ApiKeyAuth: []
summary: 修改密码
tags:
- 用户管理
/user/delete:
post:
consumes:
- application/json
parameters:
- description: 批量删除用户
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.IdsReq'
produces:
- application/json
responses:
"200":
description: 删除用户
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 删除用户
tags:
- 用户管理
/user/detail:
get:
parameters:
- description: id
in: query
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 获取用户详情成功
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/system.User'
type: object
security:
- ApiKeyAuth: []
summary: 获取用户详情
tags:
- 用户管理
/user/getUserList:
post:
consumes:
- application/json
parameters:
- description: 页码, 每页大小, 搜索条件
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.GetUserList'
produces:
- application/json
responses:
"200":
description: 获取用户列表,返回包括列表,总数,页码,每页大小
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/response.PageResult'
msg:
type: string
type: object
security:
- ApiKeyAuth: []
summary: 获取用户列表
tags:
- 用户管理
/user/grantRole:
post:
consumes:
- application/json
parameters:
- description: 用户ID, 角色ID
in: body
name: data
required: true
schema:
$ref: '#/definitions/request.GrantRole'
produces:
- application/json
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- ApiKeyAuth: []
summary: 给用户分配角色
tags:
- 用户管理
/user/save:
post:
consumes:
- application/json
parameters:
- description: 用户信息
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.User'
produces:
- application/json
responses:
"200":
description: '{"code": 200, "data": {}, "msg": "添加成功"}'
schema:
$ref: '#/definitions/response.Response'
security:
- ApiKeyAuth: []
summary: 新增用户
tags:
- 用户管理
/user/update:
post:
consumes:
- application/json
parameters:
- description: 用户ID,用户信息
in: body
name: data
required: true
schema:
$ref: '#/definitions/system.User'
produces:
- application/json
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- ApiKeyAuth: []
summary: 更新用户
tags:
- 用户管理
securityDefinitions:
ApiKeyAuth:
in: header
name: Authorization
type: apiKey
swagger: "2.0"