webApp文档
Table of Contents

总览

前后端放在同一服务器,但是依旧是分离的。所以不用考虑跨域。

后端所有URL都是/api/ 为前缀

用户相关

登录[无需验证]

URL :

[POST] user/login   [实际为/api/user/login,见总览说明]

参数

username
password

返回值

status 1为成功 0为失败
user 对象
token 放在header里的X-Auth-Token
expire 过期时长(小时)

注册发送验证码[无需验证]

URL

[POST] user/registerCode

参数

phone

返回值

1 发送成功
0 超过限制
-1 手机号已被占用
备注:测试为避免多次发送短信,可使用9999验证码跳过

注册[无需验证]

URL

[POST] user/register

参数

username
password
phone
code 验证码

返回值

status 1为成功 0为验证码错误 -1为用户名被占用
user 对象
token 放在header里的X-Auth-Token
expire 过期时长(单位为小时)

用户激活

URL

[POST] user/active/{userId}

参数

userId
------------------------
name
sysId

返回

1为成功 0为失败 -1为已经激活

补充或者修改用户信息

URL

[POST] user/general/{userId}

参数

userId 用户id
-------------------------
email 邮箱
gender 性别 男为1 女为0 
birth yyyy-mm-dd
height 身高(cm
email 邮箱
weight 体重 (kg)
备注:均可为空,即可跳过

返回值

user

获取用户信息

URL

[GET] user/{userId}

参数

userId 用户id
---------------

返回值

user对象 [null则为权限问题]

找回密码[无需验证]

URL

[POST] user/forget

参数

username
phone

返回

1 验证码已发送
0 超过限制
-1 用户名或者手机不对应

重设密码[无需验证]

URL

[POST] user/reset

参数

phone
code
password

返回

status 1为成功 0为失败
user 对象
token 放在header里的X-Auth-Token
expire 过期时长

刷新Token

URL

[GET] user/token

返回

token token
备注:只有在过期一天之内才能刷新

修改密码

URL

[POST] user/{userId}/password

参数

userId
------------------------
oldPwd
newPwd

返回

status 1为成功 0为错误
user 对象
token 放在header里的X-Auth-Token
expire 过期时长(单位为小时)

获取七牛Token

URL

[GET] user/upToken

返回值

七牛的上传token

上传头像

URL

[POST] user/{userId}/img

参数

userId
---------------
img 七牛返回的图片URL

返回

1为成功 0为失败

报告相关

获取用户报告列表

URL

[GET] report/{userId}/list

参数

userId

返回

[
  {"date":"yyyy-MM-dd","reportId":"xxxxxxx"},
  {"date":"yyyy-MM-dd","reportId":"xxxxxxx"}
  ......
]

获取用户指定id报告

URL

[GET] report/{userId}/{reportId}

参数

userId
reportId

返回

报告对象

获取报告中的字典信息

URL

[GET] report/{userId}/{reportId}/dic

参数

userId
reportId

返回

List<Dic>

字典相关

获取key的信息

URL

[GET] dic/{key}

参数

key

返回

字典详情

参考信息相关

获取参考信息

URL

[GET] reference/{name}

参数

name

返回

返回参考信息(平均值,最高值,最低值……)

日常记录相关

获取模板

URL

[GET] record/templates

参数

page 当前是第几页(0开始)可选
size 一页的数量 可选
type 类别 可选 默认全部

返回

{
  "content": [
    {
      "id": "578860d10cf2fbd465dbb864",
      "name": "牛奶",
      "type": [
        "早餐",
        "中餐",
        "晚餐",
        "加餐"
      ],
      "caloric": 5,
      "per": 10,
      "max": 1000,
      "unit": "毫升",
      "tips": "每杯 约200毫升,每盒 约250毫升;",
      "pic": "http://dl.xulog.com/牛奶-55555.jpg"
    },
    {
      "id": "5788ad670cf2fbd465dbb8f2",
      "name": "豆角",
      "type": [
        "中餐"
      ],
      "caloric": 3,
      "per": 10,
      "max": 1000,
      "unit": "克",
      "tips": "暂无;",
      "pic": "http://dl.xulog.com/豆角-82.jpg"
    }
  ],
  "totalElements": 100,
  "totalPages": 2,
  "last": false,
  "number": 0,
  "size": 50,
  "sort": null,
  "first": true,
  "numberOfElements": 50
}

获取用户指定日期记录

URL

[GET] record/{userId}/{yyyy-MM-dd}

参数

userId
yyyy-MM-dd

返回

该日期内用户的日常记录列表

添加用户日志(根据模板添加)

URL

[POST] record/{userId}/{yyyy-MM-dd}

参数

userId
yyyy-MM-dd
---------------------
type 记录类型
template 模板id
size 数量

返回

null 为失败
正常情况下为
{
 id;
 userId;
 type;
 name;
 amount;
 caloric;
 reDate;
}

添加用户日志(自定义添加)

URL

[POST] record/{userId}/{yyyy-MM-dd}/custom

参数

userId
yyyy-MM-dd
------------------------
type 记录类型
name 名称
amount 数量(比如100g2000metc
caloric 卡路里总量

返回

1 成功
0 失败
-1 日期解析错误

删除用户日志

URL

[DELETE] record/{userId}/{recordId}

参数

userId
recordId

返回

1 成功
0 失败

其他

发送邮件

URL

[POST] user/feedback

参数

name 姓名
phone 联系号码
email 邮箱
title 标题
content 内容

返回

1 成功
0 失败