API-INTEGRATION.md 3.2 KB

前后端集成文档

API端点映射

前端API调用 vs 后端Controller

前端调用 (api.js) 后端Controller 方法 说明
login(data) AuthController.login() POST 微信登录
getUserInfo() AuthController.getUserInfo() GET 获取用户信息
getTodayTasks(childId) TaskController.getTodayTasks() GET 获取今日任务
getTaskDetail(taskId) TaskController.getTaskDetail() GET 获取任务详情
createTask(data) TaskController.createTask() POST 创建任务
completeTask(taskId, data) TaskController.completeTask() POST 完成任务
reviewTask(taskId, data) TaskController.reviewTask() POST 审核任务
getFamilyTasks(familyId) TaskController.getFamilyTasks() GET 获取家庭任务列表
getRewards(familyId) RewardController.getFamilyRewards() GET 获取家庭奖励列表
getRewardDetail(rewardId) RewardController.getRewardDetail() GET 获取奖励详情
createReward(data) RewardController.createReward() POST 创建奖励
updateReward(rewardId, data) RewardController.updateReward() PUT 更新奖励
getDefaultRewards() RewardController.getDefaultRewards() GET 获取系统预设奖励
getPointsBalance(childId) PointsController.getPointsBalance() GET 获取孩子积分
getPointsLog(childId) PointsController.getPointsLog() GET 获取积分流水

数据格式

请求头

Authorization: Bearer <jwt_token>
Content-Type: application/json

响应格式

所有API响应都使用统一的Result类包装:

{
  "code": 200,
  "message": "success",
  "data": { ... }
}

错误响应

{
  "code": 500,
  "message": "错误信息"
}

配置

后端配置 (application.yml)

server:
  port: 8080
  servlet:
    context-path: /api

spring:
  application:
    name: zhixingyijia-backend
  datasource:
    url: jdbc:mysql://localhost:3306/zhixingyijia?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
    username: root
    password: root

jwt:
  secret: zhixingyijia-secret-key-2026
  expiration: 604800000

前端配置 (app.js)

globalData: {
  baseUrl: 'http://localhost:8080/api',
  token: '',
  userInfo: null,
  role: ''  // parent 或 child
}

集成测试

测试环境

  • 后端:localhost:8080
  • 前端:微信开发者工具
  • 数据库:localhost:3306

测试步骤

  1. 启动后端服务
  2. 在微信开发者工具中导入miniprogram目录
  3. 配置app.js中的baseUrl
  4. 测试登录功能
  5. 测试任务管理功能
  6. 测试奖励管理功能
  7. 测试积分管理功能

注意事项

  1. 跨域问题:开发环境下需要配置CORS
  2. JWT Token:前端需要在请求头中携带Token
  3. 数据验证:后端需要对请求参数进行验证
  4. 错误处理:前端需要处理各种错误情况
  5. 加载状态:网络请求时显示加载状态

开发建议

  1. 使用Swagger文档查看API接口:http://localhost:8080/api/swagger-ui.html
  2. 使用Postman测试API接口
  3. 使用微信开发者工具调试小程序
  4. 使用MySQL Workbench查看数据库