管家 API 文档

面向后端开发的接口规划文档,当前网站仍为纯前端静态版本。

返回网站

说明

本页面定义未来后端服务的接口标准。当前线上站点的登录、注册、用户资料、待办、日程、记账等数据仍保存在浏览器本地,不代表这些接口已经可调用。

建议后端基础地址:https://hbzdly.com.cn/api/v1,认证方式:Bearer Token。

基础约定

项目说明
请求格式Content-Type: application/json
认证头Authorization: Bearer {accessToken}
成功响应{ "code": 0, "message": "ok", "data": {} }
分页参数pagepageSize,默认 120

认证接口

POST/auth/login用户登录
{
  "username": "scorpioly",
  "password": "123456"
}
POST/auth/register新用户注册
{
  "username": "new_user",
  "password": "123456",
  "confirmPassword": "123456"
}
POST/auth/logout退出登录
{}

用户管理

以下接口仅管理员可调用。

GET/admin/users用户列表
GET/admin/users/{id}用户详情
POST/admin/users新增用户
PUT/admin/users/{id}编辑用户资料
PUT/admin/users/{id}/password修改用户密码
PUT/admin/users/{id}/security安全设置
{
  "username": "测试用户",
  "role": "普通用户",
  "status": "正常",
  "group": "默认分组",
  "tags": ["活跃用户"]
}

个人资料

GET/me获取当前用户资料
PUT/me编辑当前用户资料
PUT/me/password修改当前用户密码
PUT/me/security修改安全设置

待办事项

GET/todos查询待办列表
POST/todos新增待办
PUT/todos/{id}编辑待办
DELETE/todos/{id}删除待办

日程日历

GET/events查询日程
POST/events新增日程
PUT/events/{id}编辑日程
DELETE/events/{id}删除日程

个人记账

GET/finance查询流水
POST/finance新增流水
PUT/finance/{id}编辑流水
DELETE/finance/{id}删除流水

习惯打卡

GET/habits查询习惯
POST/habits新增习惯
POST/habits/{id}/checkin打卡或取消打卡

旅行日志

GET/travels查询旅行日志
POST/travels新增旅行日志
PUT/travels/{id}编辑旅行日志
DELETE/travels/{id}删除旅行日志

错误码

错误码含义
0请求成功
40001参数错误
40101未登录或登录已过期
40301没有权限
40401数据不存在
50001服务器内部错误