💕 情侣故事 API 接口文档

i 通用说明

响应格式

成功响应：

{
  "code": 200,
  "msg": "操作成功",
  "data": {}
}

失败响应：

{
  "code": 400,
  "msg": "错误信息",
  "data": null
}

错误码

认证方式

需要登录的接口，必须在请求头中携带 JWT Token：

Authorization: Bearer <token>

分页参数说明

时间格式

1 健康检查

检查服务状态

请求参数：无

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "message": "ok"
  }
}

2 认证相关

2.1 用户登录

请求体：

{
  "username": "10000001",
  "password": "your_password"
}

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIs...",
    "account": "10000001",
    "nickname": "张三",
    "role": 2,
    "coupleId": 1
  }
}

错误响应：

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

{
  "code": 400,
  "msg": "已分手或档案不存在，账号不可用",
  "data": null
}

2.2 修改密码

请求头：

Authorization: Bearer <token>

请求体：

{
  "oldPassword": "old_password",
  "newPassword": "new_password"
}

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": null
}

错误响应：

{
  "code": 400,
  "msg": "旧密码错误",
  "data": null
}

{
  "code": 400,
  "msg": "用户不存在",
  "data": null
}

3 情侣档案

3.1 获取当前展示情侣

请求参数：无

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "id": 1,
    "bgImg": "https://xxx.cos.com/bg.jpg",
    "boyNickname": "张三",
    "boyImg": "https://xxx.cos.com/boy.jpg",
    "girlNickname": "李四",
    "girlImg": "https://xxx.cos.com/girl.jpg",
    "startTime": "2024-01-01T00:00",
    "showStatus": 1
  }
}

3.2 获取指定情侣档案

路径参数：

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "id": 1,
    "bgImg": "https://xxx.cos.com/bg.jpg",
    "boyNickname": "张三",
    "boyImg": "https://xxx.cos.com/boy.jpg",
    "girlNickname": "李四",
    "girlImg": "https://xxx.cos.com/girl.jpg",
    "startTime": "2024-01-01T00:00",
    "endTime": "2024-12-01T00:00",
    "showStatus": 0
  }
}

3.3 创建情侣档案（管理员）

请求头：

Authorization: Bearer <token>
Content-Type: multipart/form-data

表单参数：

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": null
}

错误响应：

{
  "code": 400,
  "msg": "双方密码不能相同",
  "data": null
}

{
  "code": 403,
  "msg": "无管理员权限",
  "data": null
}

3.4 更新情侣档案

权限规则：

• 情侣成员（role = 2）：只能更新自己的情侣档案
• 管理员（role = 1）：可以更新任意情侣档案

路径参数：

表单参数（全部可选）：

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": null
}

错误响应：

{
  "code": 400,
  "msg": "没有需要更新的字段",
  "data": null
}

{
  "code": 403,
  "msg": "无权限操作该情侣档案",
  "data": null
}

{
  "code": 404,
  "msg": "情侣档案不存在",
  "data": null
}

3.5 展示情侣档案（管理员）

路径参数：

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": null
}

错误响应：

{
  "code": 404,
  "msg": "情侣档案不存在或已展示",
  "data": null
}

3.6 获取所有情侣档案（管理员）

请求参数：无

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": [
    {
      "id": 1,
      "bgImg": "https://xxx.cos.com/bg.jpg",
      "boyNickname": "张三",
      "boyImg": "https://xxx.cos.com/boy.jpg",
      "girlNickname": "李四",
      "girlImg": "https://xxx.cos.com/girl.jpg",
      "startTime": "2024-01-01T00:00",
      "showStatus": 1
    },
    {
      "id": 2,
      "bgImg": "https://xxx.cos.com/bg2.jpg",
      "boyNickname": "王五",
      "boyImg": "https://xxx.cos.com/boy2.jpg",
      "girlNickname": "赵六",
      "girlImg": "https://xxx.cos.com/girl2.jpg",
      "startTime": "2024-02-01T00:00",
      "endTime": "2024-12-01T00:00",
      "showStatus": 0
    }
  ]
}

3.7 分手/解除绑定

权限规则：

• 情侣成员（role = 2）：只能分手自己的情侣档案
• 管理员（role = 1）：可以分手任意情侣档案

路径参数：

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": null
}

错误响应：

{
  "code": 403,
  "msg": "无权限操作该情侣档案",
  "data": null
}

{
  "code": 404,
  "msg": "情侣档案不存在或已分手",
  "data": null
}

4 文章管理

4.1 文章列表

查询参数：

响应示例（分页）：

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "list": [
      {
        "id": 1,
        "author": "张三",
        "content": "这是我们在一起的第一天...",
        "createTime": "2024-01-01 12:00:00"
      }
    ],
    "total": 100
  }
}

4.2 创建文章

请求体：

{
  "content": "这是我们在一起的第一天..."
}

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": null
}

4.3 更新文章

路径参数：

请求体：

{
  "content": "更新后的文章内容..."
}

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": null
}

4.4 删除文章

路径参数：

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": null
}

5 相册管理

5.1 相册列表

查询参数：

响应示例（分页）：

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "list": [
      {
        "id": 1,
        "title": "第一次旅行",
        "imgUrl": "https://xxx.cos.com/photo1.jpg",
        "content": "我们去了海边...",
        "imgDate": "2024-01-01T00:00",
        "createTime": "2024-01-01 12:00:00"
      }
    ],
    "total": 50
  }
}

5.2 创建相册

表单参数：

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": null
}

5.3 更新相册

表单参数：

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": null
}

5.4 删除相册

路径参数：

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": null
}

6 愿望管理

6.1 愿望列表

查询参数：

响应示例（分页）：

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "list": [
      {
        "id": 1,
        "title": "一起去旅行",
        "content": "想去海边",
        "isAchieved": 0,
        "createTime": "2024-01-01 12:00:00",
        "updateTime": "2024-01-01 12:00:00"
      }
    ],
    "total": 20
  }
}

6.2 创建愿望

请求体：

{
  "title": "一起去旅行",
  "content": "想去海边"
}

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": null
}

6.3 标记愿望实现

路径参数：

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": null
}

7 留言管理

7.1 留言列表

查询参数：

响应示例（分页）：

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "list": [
      {
        "id": 1,
        "author": "访客A",
        "content": "祝你们幸福！",
        "createTime": "2024-01-01 12:00:00"
      }
    ],
    "total": 30
  }
}

7.2 创建留言

请求体：

{
  "author": "访客A",
  "content": "祝你们幸福！",
  "coupleId": 1
}

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": null
}

错误响应：

{
  "code": 400,
  "msg": "情侣档案不存在",
  "data": null
}

7.3 删除留言

路径参数：

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": null
}

附 附录

A. 角色说明

B. 文件上传限制

C. 限流说明