Skip to content

API 文档

欢迎使用悦木图库的API文档。本项目提供了丰富的RESTful API端点,支持用户管理、图片管理、帖子系统、社交互动、AI功能等多种功能。API设计遵循RESTful规范,采用JSON格式进行数据交换。

API概览

悦木图库API提供了一整套完整的接口,支持开发者构建各种应用场景:

核心功能API

  • 用户管理API:用户注册、登录、信息管理、权限设置等
  • 内容管理API:图片、帖子、评论等内容的增删改查
  • 社交互动API:点赞、收藏、分享、关注等社交功能
  • 空间管理API:个人和团队空间的创建和管理
  • AI功能API:AI聊天、RAG智能客服、图片AI处理等
  • 搜索API:全文搜索、高级筛选、热门推荐等
  • 消息通知API:实时消息推送、通知管理等
  • 数据分析API:用户行为分析、内容统计等

API特色

  • 标准化响应:统一的响应格式和错误处理
  • 安全认证:基于Token的安全认证机制
  • 频率限制:防止滥用的请求频率控制
  • 版本管理:支持API版本升级和兼容性
  • 实时推送:WebSocket支持实时消息推送
  • 全文搜索:基于Elasticsearch的高效搜索API
  • 对象存储:腾讯云COS集成的文件上传API
  • 智能推荐:个性化内容推荐API

基础信息

  • API 版本: v1
  • 协议: HTTPS
  • 内容格式: JSON
  • 认证方式: Token 认证
  • 基础 URL: /api/v1

API分类详情

开发者工具与资源

  • API测试工具:在线API测试和调试
  • SDK支持:多语言SDK支持
  • 示例代码:丰富的API调用示例
  • 沙盒环境:安全的测试环境
  • 开发者论坛:技术支持和交流社区

安全与合规

  • 认证授权:严格的用户身份验证
  • 数据保护:敏感数据加密传输
  • 访问控制:细粒度的权限控制
  • 审计日志:API调用记录和监控
  • 合规性:符合数据保护法规要求

认证

大部分API需要用户认证。认证方式为在请求头中添加 Authorization 字段,值为用户的Token。

Authorization: Bearer {token}

通用响应格式

json
{
  "code": 0,
  "data": {},
  "message": "success"
}
  • code: 响应码,0表示成功,非0表示失败
  • data: 响应数据
  • message: 响应消息

用户管理

用户注册

  • POST /user/register
  • 描述: 用户注册
  • 参数:
    • email: 邮箱
    • userPassword: 用户密码
    • checkPassword: 确认密码
    • code: 验证码
  • 频率限制: 每小时最多3次

用户登录

  • POST /user/login
  • 描述: 用户登录
  • 参数:
    • accountOrEmail: 账号或邮箱
    • userPassword: 用户密码
    • verifyCode: 验证码
    • serververifycode: 服务器验证码
  • 频率限制: 每分钟最多10次

获取当前登录用户

  • GET /user/get/login
  • 描述: 获取当前登录用户信息

修改密码

  • POST /user/changePassword
  • 描述: 修改用户密码
  • 参数:
    • oldPassword: 旧密码
    • newPassword: 新密码
    • checkPassword: 确认新密码
  • 频率限制: 每分钟最多5次

用户退出

  • POST /user/logout
  • 描述: 用户退出登录

更新用户信息

  • POST /user/update
  • 描述: 更新用户信息
  • 参数:
    • userName: 用户名
    • userProfile: 个人简介
    • gender: 性别
    • region: 地区
    • userTags: 用户标签
    • personalSign: 个性签名
    • interestField: 兴趣领域
    • themePreference: 主题偏好
    • visibilitySetting: 可见性设置
  • 频率限制: 每分钟最多10次

获取用户签到记录

  • GET /user/get/sign_in
  • 描述: 获取用户签到记录
  • 参数:
    • year: 年份(可选,默认当前年份)

添加用户签到记录

  • POST /user/add/sign_in
  • 描述: 添加用户签到记录

获取用户权限设置

  • GET /user/get/permissions
  • 描述: 获取用户权限设置
  • 参数:
    • userId: 用户ID

更新用户权限设置

  • POST /user/update/permissions
  • 描述: 更新用户权限设置
  • 参数:
    • userId: 用户ID
    • allowPrivateChat: 是否允许私聊
    • allowFollow: 是否允许关注
    • showFollowList: 是否显示关注列表
    • showFansList: 是否显示粉丝列表

图片管理

上传图片

  • POST /picture/upload
  • 描述: 上传图片
  • 参数:
    • file: 图片文件
    • title: 图片标题
    • description: 图片描述
    • tags: 图片标签
    • category: 图片分类
    • isPublic: 是否公开
    • isDraft: 是否为草稿
  • 频率限制: 每分钟最多5次

通过URL上传图片

  • POST /picture/upload/url
  • 描述: 通过URL上传图片
  • 参数:
    • fileUrl: 图片URL
    • title: 图片标题
    • description: 图片描述
    • tags: 图片标签
    • category: 图片分类
    • isPublic: 是否公开
    • isDraft: 是否为草稿
  • 频率限制: 每分钟最多5次

删除图片

  • POST /picture/delete
  • 描述: 删除图片
  • 参数:
    • id: 图片ID
  • 频率限制: 每分钟最多10次

更新图片

  • POST /picture/update
  • 描述: 更新图片信息(仅管理员)
  • 参数:
    • id: 图片ID
    • title: 图片标题
    • description: 图片描述
    • tags: 图片标签
    • category: 图片分类
    • isPublic: 是否公开

获取图片详情

  • GET /picture/get/vo
  • 描述: 获取图片详情

分页获取图片列表

  • POST /picture/list/page/vo
  • 描述: 分页获取图片列表
  • 参数:
    • current: 当前页
    • pageSize: 每页大小
    • category: 分类筛选
    • tags: 标签筛选
    • userId: 用户ID筛选
  • 频率限制: 每分钟最多30次

编辑图片

  • POST /picture/edit
  • 描述: 编辑图片
  • 参数:
    • id: 图片ID
    • title: 图片标题
    • description: 图片描述
    • tags: 图片标签
    • category: 图片分类
    • isPublic: 是否公开
  • 频率限制: 每分钟最多10次

获取图片标签分类

  • GET /picture/tag_category
  • 描述: 获取图片标签分类

审核图片

  • POST /picture/review
  • 描述: 审核图片(仅管理员)
  • 参数:
    • id: 图片ID
    • status: 审核状态
    • message: 审核信息

按颜色搜索图片

  • POST /picture/search/color
  • 描述: 按颜色搜索图片
  • 参数:
    • picColor: 图片颜色
    • spaceId: 空间ID
  • 频率限制: 每分钟最多15次

AI扩图功能

  • POST /picture/out_painting/create_task
  • 描述: 创建AI扩图任务
  • 参数:
    • pictureId: 图片ID
    • prompt: 提示词
    • direction: 扩图方向

获取AI扩图任务

  • GET /picture/out_painting/get_task
  • 描述: 获取AI扩图任务状态
  • 参数:
    • taskId: 任务ID

获取关注用户的图片

  • POST /picture/follow
  • 描述: 获取关注用户的图片列表
  • 参数:
    • current: 当前页
    • pageSize: 每页大小
  • 频率限制: 每分钟最多25次

设置图片权限

  • POST /picture/permission/set
  • 描述: 设置图片权限
  • 参数:
    • pictureId: 图片ID
    • allowCollect: 是否允许收藏
    • allowLike: 是否允许点赞
    • allowComment: 是否允许评论
    • allowShare: 是否允许分享

帖子系统

创建帖子

  • POST /post/add
  • 描述: 创建帖子
  • 参数:
    • title: 标题
    • content: 内容
    • category: 分类
    • tags: 标签
    • coverUrl: 封面图URL
    • isPublic: 是否公开
    • isDraft: 是否为草稿
  • 频率限制: 每分钟最多5次

删除帖子

  • POST /post/delete/{id}
  • 描述: 删除帖子
  • 参数:
    • id: 帖子ID
  • 频率限制: 每分钟最多10次

更新帖子

  • POST /post/update
  • 描述: 更新帖子
  • 参数:
    • id: 帖子ID
    • title: 标题
    • content: 内容
    • category: 分类
    • tags: 标签
    • coverUrl: 封面图URL
    • isPublic: 是否公开
  • 频率限制: 每分钟最多10次

获取帖子详情

  • GET /post/get/{id}
  • 描述: 获取帖子详情
  • 参数:
    • id: 帖子ID
  • 频率限制: 每分钟最多30次

分页获取帖子列表

  • POST /post/list/page
  • 描述: 分页获取帖子列表
  • 参数:
    • current: 当前页
    • pageSize: 每页大小
    • category: 分类筛选
    • tags: 标签筛选
    • userId: 用户ID筛选
  • 频率限制: 每分钟最多30次

点赞帖子

  • POST /post/like/{id}
  • 描述: 点赞/取消点赞帖子
  • 参数:
    • id: 帖子ID
  • 频率限制: 每分钟最多20次

审核帖子

  • POST /post/review/{id}
  • 描述: 审核帖子(仅管理员)
  • 参数:
    • id: 帖子ID
    • status: 审核状态
    • message: 审核信息

获取关注用户的帖子

  • POST /post/follow
  • 描述: 获取关注用户的帖子列表
  • 参数:
    • current: 当前页
    • pageSize: 每页大小
  • 频率限制: 每分钟最多20次

获取帖子榜单

  • GET /post/top100/{id}
  • 描述: 获取帖子榜单
  • 参数:
    • id: 榜单位置
  • 频率限制: 每分钟最多15次

保存帖子草稿

  • POST /post/draft/save
  • 描述: 保存帖子草稿
  • 参数:
    • title: 标题
    • content: 内容
    • category: 分类
    • tags: 标签
    • coverUrl: 封面图URL
  • 频率限制: 每分钟最多5次

获取草稿列表

  • GET /post/draft/list
  • 描述: 获取用户的草稿列表

删除草稿

  • DELETE /post/draft/{draftId}
  • 描述: 删除草稿
  • 参数:
    • draftId: 草稿ID
  • 频率限制: 每分钟最多10次

设置帖子权限

  • POST /post/permission/set
  • 描述: 设置帖子权限
  • 参数:
    • postId: 帖子ID
    • allowCollect: 是否允许收藏
    • allowLike: 是否允许点赞
    • allowComment: 是否允许评论
    • allowShare: 是否允许分享

空间管理

创建空间

  • POST /space/add
  • 描述: 创建空间
  • 参数:
    • name: 空间名称
    • description: 空间描述
    • category: 空间分类
    • isPublic: 是否公开
    • bgUrl: 背景图URL
  • 频率限制: 每小时最多5次

删除空间

  • POST /space/delete
  • 描述: 删除空间
  • 参数:
    • id: 空间ID

更新空间

  • POST /space/update
  • 描述: 更新空间信息(仅管理员)
  • 参数:
    • id: 空间ID
    • name: 空间名称
    • description: 空间描述
    • category: 空间分类
    • isPublic: 是否公开
    • bgUrl: 背景图URL

获取空间详情

  • GET /space/get/vo
  • 描述: 获取空间详情
  • 参数:
    • id: 空间ID

分页获取空间列表

  • POST /space/list/page/vo
  • 描述: 分页获取空间列表
  • 参数:
    • current: 当前页
    • pageSize: 每页大小
    • category: 分类筛选
    • userId: 用户ID筛选
  • 频率限制: 每分钟最多30次

编辑空间

  • POST /space/edit
  • 描述: 编辑空间
  • 参数:
    • id: 空间ID
    • name: 空间名称
    • description: 空间描述
    • category: 空间分类
    • isPublic: 是否公开
    • bgUrl: 背景图URL
  • 频率限制: 每分钟最多10次

获取空间级别列表

  • GET /space/list/level
  • 描述: 获取空间级别列表

设置空间推荐状态

  • POST /space/recommend
  • 描述: 设置空间推荐状态
  • 参数:
    • spaceId: 空间ID
    • recommendStatus: 推荐状态(0-取消推荐,1-推荐)

获取推荐空间列表

  • GET /space/recommended
  • 描述: 获取推荐空间列表

空间分析接口

  • POST /space/analyze/usage

  • 描述: 获取空间使用情况分析

  • 参数:

    • spaceId: 空间ID
    • startDate: 开始日期
    • endDate: 结束日期
  • POST /space/analyze/category

  • 描述: 获取空间图片分类分析

  • 参数:

    • spaceId: 空间ID
  • POST /space/analyze/tag

  • 描述: 获取空间图片标签分析

  • 参数:

    • spaceId: 空间ID

社交互动

评论管理

添加评论

  • POST /comments/add
  • 描述: 添加评论
  • 参数:
    • targetId: 目标ID
    • targetType: 目标类型(1-图片,2-帖子)
    • content: 评论内容
    • parentId: 父评论ID(可选)
  • 频率限制: 每分钟最多10次

删除评论

  • POST /comments/delete
  • 描述: 删除评论
  • 参数:
    • id: 评论ID
  • 频率限制: 每分钟最多10次

点赞评论

  • POST /comments/like
  • 描述: 点赞/取消点赞评论
  • 参数:
    • id: 评论ID
  • 频率限制: 每分钟最多20次

查询评论列表

  • POST /comments/query
  • 描述: 查询评论列表
  • 参数:
    • targetId: 目标ID
    • targetType: 目标类型
    • current: 当前页
    • pageSize: 每页大小
  • 频率限制: 每分钟最多30次

获取未读评论

  • GET /comments/unread
  • 描述: 获取未读评论列表
  • 频率限制: 每分钟最多20次

点赞管理

通用点赞接口

  • POST /like/do
  • 描述: 通用点赞接口
  • 参数:
    • targetId: 目标ID
    • targetType: 目标类型(1-图片,2-帖子,3-评论)
  • 频率限制: 每分钟最多20次

获取点赞状态

  • GET /like/status/{targetType}/{targetId}
  • 描述: 获取点赞状态
  • 参数:
    • targetType: 目标类型
    • targetId: 目标ID
  • 频率限制: 每分钟最多30次

获取未读点赞消息

  • GET /like/unread
  • 描述: 获取未读点赞消息
  • 频率限制: 每分钟最多20次

收藏管理

添加收藏

  • POST /favorite-record/add
  • 描述: 添加收藏记录
  • 参数:
    • targetId: 目标ID
    • targetType: 目标类型(1-图片,2-帖子)
  • 频率限制: 每分钟最多10次

取消收藏

  • POST /favorite-record/cancel
  • 描述: 取消收藏
  • 参数:
    • userId: 用户ID
    • targetId: 目标ID
    • targetType: 目标类型
  • 频率限制: 每分钟最多10次

检查是否已收藏

  • GET /favorite-record/check
  • 描述: 检查是否已收藏
  • 参数:
    • userId: 用户ID
    • targetId: 目标ID
    • targetType: 目标类型
  • 频率限制: 每分钟最多20次

获取未读收藏消息

  • GET /favorite-record/unread
  • 描述: 获取未读收藏消息

关注管理

关注/取关用户

  • POST /userfollows/adduserfollows
  • 描述: 关注或取关用户
  • 参数:
    • followingId: 被关注用户ID
  • 频率限制: 每分钟最多10次

检查是否关注

  • POST /userfollows/findisfollow
  • 描述: 检查是否关注某用户
  • 参数:
    • followingId: 被关注用户ID
  • 频率限制: 每分钟最多30次

获取关注/粉丝列表

  • POST /userfollows/getfolloworfanlist
  • 描述: 获取关注或粉丝列表
  • 参数:
    • searchType: 搜索类型(0-关注,1-粉丝)
    • current: 当前页
    • pageSize: 每页大小
  • 频率限制: 每分钟最多20次

获取关注和粉丝数量

  • POST /userfollows/getfollowandfanscount/{id}
  • 描述: 获取关注和粉丝数量
  • 参数:
    • id: 用户ID
  • 频率限制: 每分钟最多50次

分享管理

通用分享接口

  • POST /share/do
  • 描述: 通用分享接口
  • 参数:
    • targetId: 目标ID
    • targetType: 目标类型(1-图片,2-帖子)
  • 频率限制: 每分钟最多20次

获取分享状态

  • GET /share/status/{targetType}/{targetId}
  • 描述: 获取分享状态
  • 参数:
    • targetType: 目标类型
    • targetId: 目标ID
  • 频率限制: 每分钟最多30次

获取未读分享消息

  • GET /share/unread
  • 描述: 获取未读分享消息
  • 频率限制: 每分钟最多30次

AI与RAG功能

AI聊天

发送AI消息

  • POST /deepseek/send
  • 描述: 发送消息到AI
  • 参数:
    • query: 用户查询内容
  • 频率限制: 每分钟最多15次

获取AI聊天历史

  • POST /deepseek/history
  • 描述: 获取AI聊天历史
  • 参数:
    • current: 当前页
    • pageSize: 每页大小
  • 频率限制: 每分钟最多30次

RAG智能客服

智能客服对话

  • POST /rag/chat
  • 描述: 与RAG智能客服对话
  • 参数:
    • question: 用户问题
  • 频率限制: 每分钟最多10次

清除用户对话上下文

  • POST /rag/clearContext
  • 描述: 清除用户对话上下文
  • 频率限制: 每分钟最多5次

智能客服流式对话

  • GET /rag/chat/stream
  • 描述: 与RAG智能客服流式对话
  • 参数:
    • question: 用户问题
  • 频率限制: 每分钟最多10次

RAG会话管理

创建会话

  • POST /rag/session/create
  • 描述: 创建新的RAG会话
  • 参数:
    • sessionName: 会话名称(可选)
  • 频率限制: 每分钟最多5次

会话列表查询

  • GET /rag/session/list
  • 描述: 查询用户会话列表
  • 参数:
    • current: 当前页
    • pageSize: 每页大小
  • 频率限制: 每分钟最多30次

会话切换

  • POST /rag/session/switch
  • 描述: 切换当前会话
  • 参数:
    • sessionId: 会话ID
  • 频率限制: 每分钟最多10次

会话删除

  • POST /rag/session/delete
  • 描述: 删除会话
  • 参数:
    • sessionId: 会话ID
  • 频率限制: 每分钟最多10次

更新会话名称

  • POST /rag/session/updateName
  • 描述: 更新会话名称
  • 参数:
    • id: 会话ID
    • sessionName: 新会话名称
  • 频率限制: 每分钟最多10次

RAG消息问答

发送消息

  • POST /rag/qa/message/send
  • 描述: 发送消息到RAG系统
  • 参数:
    • content: 消息内容
    • sessionId: 会话ID(可选)
  • 频率限制: 每分钟最多15次

获取AI回答

  • POST /rag/qa/message/answer
  • 描述: 获取AI的回答
  • 参数:
    • sessionId: 会话ID
    • content: 用户消息内容
  • 频率限制: 每分钟最多15次

会话消息列表

  • GET /rag/qa/message/list
  • 描述: 获取会话消息列表
  • 参数:
    • sessionId: 会话ID
    • current: 当前页
    • pageSize: 每页大小
  • 频率限制: 每分钟最多30次

流式发送消息

  • POST /rag/qa/message/send/stream
  • 描述: 流式发送消息并接收AI回复
  • 参数:
    • content: 消息内容
    • sessionId: 会话ID(可选)
  • 频率限制: 每分钟最多15次

清除会话上下文

  • POST /rag/qa/message/clearContext
  • 描述: 清除会话上下文
  • 参数:
    • sessionId: 会话ID
  • 频率限制: 每分钟最多10次

活动管理

创建活动

  • POST /activity/add
  • 描述: 创建活动
  • 参数:
    • title: 活动标题
    • description: 活动描述
    • startTime: 开始时间
    • endTime: 结束时间
    • location: 活动地点
    • spaceId: 空间ID(可选,不填则为全站活动)
  • 频率限制: 每小时最多5次

获取活动列表

  • POST /activity/list/page
  • 描述: 分页获取活动列表
  • 参数:
    • current: 当前页
    • pageSize: 每页大小
    • title: 活动标题(可选,模糊搜索)
  • 频率限制: 每分钟最多30次

获取空间活动列表

  • POST /activity/list/page/space
  • 描述: 分页获取空间活动列表
  • 参数:
    • current: 当前页
    • pageSize: 每页大小
    • spaceId: 空间ID
  • 频率限制: 每分钟最多30次

获取轮播图活动

  • POST /activity/list/carousel
  • 描述: 获取轮播图活动列表(全站活动)
  • 参数:
    • current: 当前页
    • pageSize: 每页大小
  • 频率限制: 每分钟最多30次

获取活动详情

  • GET /activity/get
  • 描述: 获取活动详情
  • 参数:
    • id: 活动ID

审核活动

  • POST /activity/review
  • 描述: 审核活动(仅管理员)
  • 参数:
    • activityId: 活动ID
    • status: 审核状态
    • message: 审核信息

删除活动

  • POST /activity/delete
  • 描述: 删除活动
  • 参数:
    • id: 活动ID
  • 频率限制: 每分钟最多10次

搜索功能

综合搜索

  • POST /search/all
  • 描述: 综合搜索(图片、用户、帖子、空间)
  • 参数:
    • keyword: 搜索关键词
    • type: 搜索类型(picture/user/post/space)
    • current: 当前页
    • pageSize: 每页大小
  • 频率限制: 每分钟最多20次

获取热门搜索

  • GET /search/hot
  • 描述: 获取热门搜索关键词
  • 参数:
    • type: 搜索类型(picture/user/post/space)
    • size: 返回数量(默认9个)
  • 频率限制: 每分钟最多30次

获取用户搜索历史

  • GET /search/history
  • 描述: 获取用户搜索历史
  • 参数:
    • userId: 用户ID
    • type: 搜索类型(picture/user/post/space)
    • size: 返回数量(默认10个)
  • 频率限制: 每分钟最多20次

删除用户搜索历史

  • DELETE /search/history
  • 描述: 删除用户指定类型的搜索历史
  • 参数:
    • type: 搜索类型(picture/user/post/space)

获取猜你想搜

  • GET /search/guess
  • 描述: 获取猜你想搜的数据
  • 参数:
    • type: 搜索类型(picture/user/post/space)
    • size: 返回数量(默认10个)
  • 频率限制: 每分钟最多20次

消息中心

获取消息列表

  • GET /message/list
  • 描述: 按类型获取用户消息列表
  • 参数:
    • type: 消息类型(comment/like/share/system)
    • current: 当前页
    • pageSize: 每页大小
  • 频率限制: 每分钟最多25次

标记单个消息为已读

  • POST /message/read/{type}/{id}
  • 描述: 标记单个消息为已读
  • 参数:
    • type: 消息类型(comment/like/share/system)
    • id: 消息ID
  • 频率限制: 每分钟最多20次

获取未读消息统计

  • GET /message/unread/count/all
  • 描述: 获取所有未读消息统计
  • 频率限制: 每分钟最多30次

标记所有消息为已读

  • POST /message/read/all
  • 描述: 标记所有消息为已读
  • 频率限制: 每分钟最多10次

浏览记录

添加浏览记录

  • POST /view-record/add
  • 描述: 添加浏览记录
  • 参数:
    • targetId: 目标ID
    • targetType: 目标类型(1-图片,2-帖子)
    • duration: 浏览时长(秒)

检查是否已浏览

  • GET /view-record/check
  • 描述: 检查是否已浏览
  • 参数:
    • userId: 用户ID
    • targetId: 目标ID
    • targetType: 目标类型

批量上报浏览时长

  • POST /view-record/report-duration
  • 描述: 批量上报浏览时长
  • 参数:
    • 数组形式的浏览记录对象
      • targetId: 目标ID
      • targetType: 目标类型
      • duration: 浏览时长(秒)
  • 频率限制: 每分钟最多60次

获取我的浏览记录

  • POST /view-record/my/list/page
  • 描述: 分页获取我的浏览记录
  • 参数:
    • current: 当前页
    • pageSize: 每页大小
    • targetType: 目标类型(可选)
  • 频率限制: 每分钟最多20次

删除浏览记录

  • POST /view-record/delete
  • 描述: 删除浏览记录(支持单个或批量)
  • 参数:
    • 数组形式的ID列表
  • 频率限制: 每分钟最多10次

留言板

添加留言

  • POST /message-board/add
  • 描述: 添加留言
  • 参数:
    • content: 留言内容
    • ownerId: 留言板主人ID
  • 频率限制: 每分钟最多5次

分页获取留言列表

  • GET /message-board/list/page
  • 描述: 分页获取留言列表
  • 参数:
    • current: 当前页
    • size: 每页大小
    • ownerId: 留言板主人ID

点赞留言

  • POST /message-board/like/{id}
  • 描述: 点赞留言
  • 参数:
    • id: 留言ID
  • 频率限制: 每分钟最多10次

更新留言状态

  • POST /message-board/status
  • 描述: 更新留言状态(显示/隐藏)
  • 参数:
    • id: 留言ID
    • status: 状态(0-隐藏,1-显示)
  • 频率限制: 每分钟最多20次

删除留言

  • DELETE /message-board/{id}
  • 描述: 删除留言
  • 参数:
    • id: 留言ID
    • ownerId: 留言板主人ID
  • 频率限制: 每分钟最多10次

恋爱空间

创建恋爱空间

  • POST /love-board/add
  • 描述: 创建恋爱空间
  • 参数:
    • manName: 男方姓名
    • womanName: 女方姓名
    • anniversaryDate: 纪念日
    • description: 描述
    • bgUrl: 背景图URL

获取恋爱空间详情

  • GET /love-board/get
  • 描述: 获取恋爱空间详情
  • 参数:
    • id: 恋爱空间ID

获取我的恋爱空间

  • GET /love-board/my
  • 描述: 获取我的恋爱空间

分页获取公共恋爱空间列表

  • GET /love-board/list/public
  • 描述: 分页获取公共恋爱空间列表
  • 参数:
    • current: 当前页(默认1)
    • size: 每页大小(默认15)
    • manName: 男方姓名(可选)
    • womanName: 女方姓名(可选)
    • sortField: 排序字段(默认viewCount)
    • sortOrder: 排序顺序(默认desc)
  • 频率限制: 每分钟最多25次

更新恋爱空间

  • POST /love-board/update
  • 描述: 更新恋爱空间
  • 参数:
    • id: 恋爱空间ID
    • manName: 男方姓名
    • womanName: 女方姓名
    • anniversaryDate: 纪念日
    • description: 描述
    • bgUrl: 背景图URL

删除恋爱空间

  • POST /love-board/delete
  • 描述: 删除恋爱空间
  • 参数:
    • id: 恋爱空间ID

时光相册

创建相册

  • POST /timeAlbum/add
  • 描述: 创建时光相册
  • 参数:
    • name: 相册名称
    • description: 相册描述
    • coverUrl: 封面图URL
    • loveBoardId: 关联的恋爱空间ID
  • 频率限制: 每小时最多5次

获取相册详情

  • GET /timeAlbum/get
  • 描述: 获取相册详情
  • 参数:
    • id: 相册ID
    • userId: 用户ID(可选)
    • password: 密码(可选)

分页获取相册列表

  • GET /timeAlbum/list
  • 描述: 分页获取相册列表
  • 参数:
    • current: 当前页
    • pageSize: 每页大小
    • loveBoardId: 恋爱空间ID
  • 频率限制: 每分钟最多30次

更新相册

  • POST /timeAlbum/update
  • 描述: 更新相册
  • 参数:
    • id: 相册ID
    • name: 相册名称
    • description: 相册描述
    • coverUrl: 封面图URL
    • loveBoardId: 关联的恋爱空间ID
  • 频率限制: 每分钟最多10次

删除相册

  • POST /timeAlbum/delete
  • 描述: 删除相册
  • 参数:
    • id: 相册ID
    • loveBoardId: 恋爱空间ID
  • 频率限制: 每分钟最多10次

上传爱心墙图片

  • POST /timeAlbum/heart-wall/upload
  • 描述: 上传爱心墙图片
  • 参数:
    • albumId: 相册ID
    • files: 图片文件数组
  • 频率限制: 每小时最多20次

获取爱心墙图片列表

  • GET /timeAlbum/heart-wall/list
  • 描述: 获取爱心墙图片列表
  • 参数:
    • albumId: 相册ID
    • userId: 用户ID(可选)
    • password: 密码(可选)
  • 频率限制: 每分钟最多30次

删除爱心墙图片

  • POST /timeAlbum/heart-wall/delete
  • 描述: 删除爱心墙图片
  • 参数:
    • pictureId: 图片ID
    • albumId: 相册ID
  • 频率限制: 每分钟最多10次

设置相册密码

  • POST /timeAlbum/password/set
  • 描述: 设置相册密码
  • 参数:
    • albumId: 相册ID
    • newPassword: 新密码
  • 频率限制: 每分钟最多5次

修改相册密码

  • POST /timeAlbum/password/update
  • 描述: 修改相册密码
  • 参数:
    • albumId: 相册ID
    • oldPassword: 旧密码
    • newPassword: 新密码
  • 频率限制: 每分钟最多5次

移除相册密码

  • POST /timeAlbum/password/remove
  • 描述: 移除相册密码
  • 参数:
    • albumId: 相册ID
    • oldPassword: 旧密码
  • 频率限制: 每分钟最多5次

微言功能

添加微言

  • POST /weiyan/add
  • 描述: 添加微言
  • 参数:
    • content: 微言内容
    • loveBoardId: 恋爱空间ID
  • 频率限制: 每小时最多10次

删除微言

  • POST /weiyan/delete
  • 描述: 删除微言
  • 参数:
    • id: 微言ID
    • loveBoardId: 恋爱空间ID

更新微言

  • POST /weiyan/update
  • 描述: 更新微言
  • 参数:
    • id: 微言ID
    • content: 微言内容
    • loveBoardId: 恋爱空间ID
  • 频率限制: 每分钟最多10次

获取微言列表

  • GET /weiyan/list
  • 描述: 获取微言列表
  • 参数:
    • loveBoardId: 恋爱空间ID
    • userId: 用户ID(可选)
    • current: 当前页(默认1)
    • pageSize: 每页大小(默认10)
  • 频率限制: 每分钟最多30次

点赞微言

  • POST /weiyan/like
  • 描述: 点赞微言
  • 参数:
    • id: 微言ID
  • 频率限制: 每分钟最多20次

音频管理

上传音频

  • POST /audio/upload
  • 描述: 上传音频文件
  • 参数:
    • file: 音频文件
    • title: 音频标题
    • description: 音频描述
    • artist: 艺术家
    • album: 专辑
    • genre: 音乐类型
    • spaceId: 空间ID(可选)
  • 频率限制: 每小时最多10次

删除音频

  • DELETE /audio/{id}
  • 描述: 删除音频文件
  • 参数:
    • id: 音频ID
  • 频率限制: 每分钟最多20次

获取音频详情

  • GET /audio/{id}
  • 描述: 获取音频详情
  • 参数:
    • id: 音频ID

分页获取音频列表

  • GET /audio/list/page
  • 描述: 分页获取音频列表
  • 参数:
    • current: 当前页
    • pageSize: 每页大小
    • spaceId: 空间ID(可选)
    • genre: 音乐类型(可选)
  • 频率限制: 每分钟最多30次

举报功能

提交举报

  • POST /report/add
  • 描述: 提交举报
  • 参数:
    • targetId: 被举报内容ID
    • targetType: 被举报内容类型(1-图片,2-帖子,3-评论,4-用户,5-其他)
    • reportType: 举报类型(1-色情低俗,2-政治敏感,3-暴力恐怖,4-虚假信息,5-垃圾广告,6-侵犯隐私,7-其他)
    • reason: 举报原因
    • screenshotUrls: 截图URL列表(可选)
  • 频率限制: 每分钟最多10次

获取我的举报列表

  • POST /report/my/list/page
  • 描述: 获取我的举报列表
  • 参数:
    • current: 当前页
    • pageSize: 每页大小
  • 频率限制: 每分钟最多20次

系统管理

获取系统统计信息

  • GET /dashboard/stats
  • 描述: 获取系统统计信息(用户、图片、帖子、空间等新增数量)

获取图表数据

  • GET /dashboard/charts
  • 描述: 获取图表数据(用户统计、图片分类、帖子状态、空间趋势等)

Redis缓存监控

  • GET /monitor/cache/info

  • 描述: 获取Redis监控信息(仅管理员)

  • GET /monitor/cache/memory

  • 描述: 获取Redis内存使用信息(仅管理员)

  • GET /monitor/cache/keys

  • 描述: 获取Redis键值统计信息(仅管理员)


应用管理

获取最新版本信息

  • GET /app/version
  • 描述: 获取最新APP版本信息
  • 频率限制: 每分钟最多30次

下载APK

  • GET /app/download
  • 描述: 下载最新APK文件
  • 频率限制: 每小时最多5次

获取版本历史

  • GET /app/history
  • 描述: 获取APP版本历史
  • 参数:
    • current: 当前页(默认1)
    • pageSize: 每页大小(默认10)
  • 频率限制: 每分钟最多20次

上传新版本(仅管理员)

  • POST /app/upload
  • 描述: 上传新版本APK
  • 参数:
    • file: APK文件
    • appVersion: 版本信息JSON字符串
      • version: 版本号
      • versionCode: 版本代码
      • description: 版本描述
      • isForce: 是否强制更新

Released under the MIT License.