API文档首页

欢迎使用时光情侣空间API接口文档。本API提供了一套完整的接口，用于构建和管理情侣纪念册相关功能，包括用户认证、恋爱信息管理、文章发布、相册管理、愿望清单和留言功能等。

根API地址: https://java.lv.cxfjh.cn

在线版体验: https://lv.cxfjh.cn

接口概览

本系统API分为公开接口（/public）和私有接口（/private）两大类，覆盖了恋爱纪念册所需的各项功能。

公开接口

无需身份认证即可访问，方便用户浏览和获取公开信息，部分接口有访问限制。

https://java.lv.cxfjh.cn/public/*

私有接口

需要身份认证才能访问，用于管理用户私有数据，确保数据安全和隐私保护。

https://java.lv.cxfjh.cn/private/*

通用说明

  • 所有接口返回格式统一为JSON对象，包含操作结果状态和数据
  • 私有接口需要在请求头中携带Authorization字段，格式为Bearer {token}
  • 时间格式统一为yyyy-MM-dd'T'HH:mm或yyyy-MM-dd HH:mm:ss
  • 文件上传接口需使用multipart/form-data格式
  • 所有非200状态码均表示请求失败，详细错误信息在msg字段中

1. 认证接口（Auth）

1.1 用户登录

POST

接口地址

https://java.lv.cxfjh.cn/public/login

接口类型

公开接口

描述

用户登录并获取认证token，用于访问私有接口

请求体参数

{
  "username": "用户名",
  "password": "密码"
}

返回结果

成功：

{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  }
}

失败：

{
  "code": 400,
  "msg": "用户名或密码错误",
  "data": null
}

1.2 用户注册

POST 已经弃用

接口地址

https://java.lv.cxfjh.cn/public/register

接口类型

公开接口

描述

新用户注册接口，创建账号用于登录系统

请求体参数

{
  "username": "用户名",
  "password": "密码"
}

返回结果

{
  "code": 200,
  "msg": "请求成功",
  "data": ""
}

1.3 修改密码

PUT 需要认证

接口地址

https://java.lv.cxfjh.cn/private/changePwd

接口类型

私有接口

描述

用于修改密码

请求体参数

{
  "username": "用户名",
  "password": "密码",
  "newPassword": "新密码"
}

返回结果

{
  "code": 200,
  "msg": "修改密码成功！",
  "data": ""
}

1.4 分手

PUT 需要认证

接口地址

https://java.lv.cxfjh.cn/private/breakUp

接口类型

私有接口

描述

用于分手

返回结果

{
  "code": 200,
  "msg": "分手成功！",
  "data": ""
}

2. 恋爱信息接口

2.1 新增恋爱基本信息

POST 需要认证

接口地址

https://java.lv.cxfjh.cn/private/info

接口类型

私有接口（需认证）

描述

新增恋爱基本信息，包括双方信息和相关图片

成功将自动注册两个账号，账号：boyName | boyName，密码：1234

请求参数

参数名 类型 位置 是否必须 描述
info Object FormData 是 恋爱信息实体（boyName、girlName、startTime）
bgImg File FormData 是 背景图片，大小限制200KB以内
boyImg File FormData 是 男生照片，大小限制100KB以内
girlImg File FormData 是 女生照片，大小限制100KB以内

返回结果

成功：

{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "id": 1
  }
}

失败：

{
  "code": 400,
  "msg": "新增信息失败",
  "data": null
}

2.2 查询恋爱基本信息

GET

接口地址

https://java.lv.cxfjh.cn/public/info

接口类型

公开接口

描述

查询恋爱基本信息，包括双方姓名、照片和恋爱开始时间等

请求参数

参数名 类型 位置 是否必须 描述
id Integer Query 否 信息ID，默认值为-1

返回结果

{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "id": 1,
    "bgImg": "https://xxx.cos.xxx.myqcloud.com/bg.jpg",
    "boyName": "男孩姓名",
    "boyImg": "https://xxx.cos.xxx.myqcloud.com/boy.jpg",
    "girlName": "女孩姓名",
    "girlImg": "https://xxx.cos.xxx.myqcloud.com/girl.jpg",
    "startTime": "2023-01-01T12:00"
  }
}

3. 文章接口

3.1 新增文章

POST 需要认证

接口地址

https://java.lv.cxfjh.cn/private/article

接口类型

私有接口（需认证）

描述

新增恋爱相关的文章内容，记录恋爱点滴和回忆

请求体参数

{
  "content": "文章内容",
}

返回结果

成功：

{
  "code": 200,
  "msg": "请求成功",
  "data": "新增文章成功"
}

失败：

{
  "code": 400,
  "msg": "新增文章失败",
  "data": null
}

3.2 查询文章

GET

接口地址

https://java.lv.cxfjh.cn/public/article

接口类型

公开接口

描述

查询文章内容列表，可根据相关度参数筛选

请求参数

参数名 类型 位置 是否必须 描述
relevancy Integer Query 否 相关度参数，默认值为-1

返回结果

{
  "code": 200,
  "msg": "请求成功",
  "data": [
    {
      "id": 1,
      "author": "用户名",
      "content": "文章内容...",
      "createTime": "2023-01-01 12:00:00"
    }
  ]
}

4. 相册接口

4.1 新增相册信息

POST 需要认证

接口地址

https://java.lv.cxfjh.cn/private/album

接口类型

私有接口（需认证）

描述

新增相册信息及对应的图片文件，记录美好瞬间

请求参数

参数名 类型 位置 是否必须 描述
album Object FormData 是 相册信息对象（title、content、imgDate）
imgFile File FormData 是 相册图片，大小限制500KB以内

返回结果

成功：

{
  "code": 200,
  "msg": "请求成功",
  "data": "上传照片成功！"
}

失败：

{
  "code": 400,
  "msg": "上传照片失败！",
  "data": null
}

4.2 查询相册信息

GET

接口地址

https://java.lv.cxfjh.cn/public/album

接口类型

公开接口

描述

查询相册信息列表，可根据相关性参数筛选

请求参数

参数名 类型 位置 是否必须 描述
relevancy Integer Query 否 相关性筛选参数，默认值为-1

返回结果

{
  "code": 200,
  "msg": "请求成功",
  "data": [
    {
      "id": 1,
      "imgUrl": "https://xxx.cos.xxx.myqcloud.com/photo1.jpg",
      "description": "照片描述",
      "imgDate": "2023-01-01 12:00:00"
      "createTime": "2023-01-01 12:00:00"
    }
  ]
}

5. 愿望清单接口

5.1 新增愿望

POST 需要认证

接口地址

https://java.lv.cxfjh.cn/private/wish

接口类型

私有接口（需认证）

描述

新增情侣共同愿望

请求体参数

{
  "title": "愿望标题",
  "content": "愿望内容",
}

返回结果

成功：

{
  "code": 200,
  "msg": "请求成功",
  "data": "新增愿望成功"
}

失败：

{
  "code": 400,
  "msg": "新增愿望失败",
  "data": null
}

5.2 查询愿望列表

GET

接口地址

https://java.lv.cxfjh.cn/public/wish

接口类型

公开接口

描述

查询愿望清单，可查看已实现和未实现的愿望

请求参数

参数名 类型 位置 是否必须 描述
relevancy Integer Query 否 关联标识，默认值为-1

返回结果

{
  "code": 200,
  "msg": "请求成功",
  "data": [
    {
      "id": 1,
      "title": "愿望标题",
      "content": "愿望内容",
      "isAchieved": 0,
      "createTime": "2023-01-01 12:00:00"
    }
  ]
}

5.3 更新愿望状态

PUT 需要认证

接口地址

https://java.lv.cxfjh.cn/private/wish

接口类型

私有接口（需认证）

描述

更新愿望状态（标记为已实现或未实现）

请求体参数

{
  "id": 1,
  "isAchieved": 1
}

返回结果

成功：

{
  "code": 200,
  "msg": "请求成功",
  "data": "更新愿望成功"
}

失败：

{
  "code": 400,
  "msg": "更新愿望失败",
  "data": null
}

6. 留言接口

6.1 提交留言

POST

接口地址

https://java.lv.cxfjh.cn/public/messages

接口类型

公开接口（带IP限流）

描述

提交留言，用于访客或用户留下祝福或评论，带有IP限流防止滥用

请求体参数

{
  "author": "留言者",
  "content": "留言内容",
}

返回结果

成功：

{
  "code": 200,
  "msg": "请求成功",
  "data": "留言成功"
}

失败：

{
  "code": 400,
  "msg": "留言失败",
  "data": null
}

6.2 查询留言

GET

接口地址

https://java.lv.cxfjh.cn/public/message

接口类型

公开接口

描述

查询留言列表，可查看所有公开留言

请求参数

参数名 类型 位置 是否必须 描述
relevancy Integer Query 否 关联标识，默认值为-1

返回结果

{
  "code": 200,
  "msg": "请求成功",
  "data": [
    {
      "id": 1,
      "author": "留言者",
      "content": "留言内容",
      "createTime": "2023-01-01 12:00:00"
    }
  ]
}

6.3 删除留言

DELETE 需要认证

接口地址

https://java.lv.cxfjh.cn/private/message

接口类型

私有接口（需认证）

描述

删除指定留言，仅管理员或留言作者可操作

请求体参数

{
  "id": 1
}

返回结果

成功：

{
  "code": 200,
  "msg": "请求成功",
  "data": "删除留言成功"
}

失败：

{
  "code": 400,
  "msg": "删除留言失败",
  "data": null
}

7. 通用响应格式

所有接口返回数据均遵循以下JSON格式：

{
  "code": 200, // 状态码，200表示成功，其他表示失败
  "msg": "请求成功", // 操作结果描述信息
  "data": null // 具体返回数据，成功时可能有数据，失败时为null
}

8. 错误码说明

错误码 说明 可能原因
200 操作成功 请求已正常处理并返回结果
400 请求参数错误 提交的参数格式不正确或缺少必要参数
401 未授权访问 未提供认证信息或认证信息无效
403 权限不足 当前用户没有执行该操作的权限
404 资源不存在 请求的资源或接口不存在
429 请求过于频繁 超出了接口的访问频率限制
500 服务器内部错误 服务器处理请求时发生错误