app接口文档模板

Base_Url:“http://192.168.1.151:8080/api”

统一header：{

token：“xxxxxxxxxx”，

timestamp：“”

}

token生成规则：uid（base64加密）+生成时间戳（base64加密）+到期时间戳（base64加密）

1.用户登录

Url	（Base_Url）/customer/ login
方法	Post
header	无
参数	username	用户名
	password	密码
参数举例	{ “username”:””, “password”:”c833e923c2e7bffed05b4044fd345c9f” }
成功返回			失败返回
{ code：0， data：{ nickName:””, familyImg:””, sex:”” familyId:”” birthDay:”” hight:”” weight:”” token:””}， msg：“操作成功” }			{ “code“: 1, “msg“:xxx }
字段说明
nickName	昵称
familyImg	头像地址
sex	性别
familyId	家庭成员id
birthDay	出生日期
hight	身高
weight	体重
token	唯一身份验证

2.用户注册

Url	（Base_Url）/customer/ register
方法	Post
header	无
参数	username	用户名
	password	密码
	verification	验证码
参数举例	{ “username”:””, “password”:”c833e923c2e7bffed05b4044fd345c9f”， “verification”:”” }
成功返回			失败返回
{ code：0， msg：“注册成功” }			{ “code“: 1, “msg“:xxx }
备注	验证手机号是否已注册

3.忘记密码

Url	（Base_Url）/customer/ repass
方法	Post
header	无
参数	username	用户名
	password	密码
	verification	验证码
参数举例	{ “username”:””, “password”:”c833e923c2e7bffed05b4044fd345c9f”， “verification”:”” }
成功返回			失败返回
{ code：0， msg：“重置密码成功” }			{ “code“: 1, “msg“:xxx }

4.修改密码

Url	（Base_Url）/customer/ editpassword
方法	Post
header	有
参数	password	原密码
	newpassword	新密码
参数举例	{ “password”:”c833e923c2e7bffed05b4044fd345c9f”, “newpassword”:”c833e923c2e7bffed05b4044fd345c9f” }
成功返回			失败返回
{ code：0， msg：“修改密码成功” }			{ “code“: 1, “msg“:xxx }

5.修改手机号

Url	（Base_Url）/customer/ edittelephone
方法	Post
header	有
参数	telephone	新手机号
	verification	验证码
参数举例	{ “telephone”:””, “verification”:”” }
成功返回			失败返回
{ code：0， msg：“修改成功” }			{ “code“: 1, “msg“:xxx }
备注	验证手机号是否已注册

6.用户反馈

7.创建家庭成员

Url	（Base_Url）/customer/ family/add
方法	Post
header	有
参数	contactPhone	紧急联系人电话（String）
	familyName	家庭成员姓名（String）
	birth	出生日期（String）
	imagePath	头像地址（String）
	sex	性别（int 0.男 1.女）
	height	身高（int）
	weight	体重（int）
参数举例	{ “birth”:”1991-07-07″,” contactPhone”:””, “familyName”:”“, “height”:172, “imagePath”:”http://file.machtalk.net:8090/group2/M00/02/5F/Cgq4YVhuCECEU4lEAAAAAET38Jc740.png”, “sex”:0, “weight”:64 }
成功返回			失败返回
{ code：0， msg：“操作成功” }			{ “code“: 1, “msg“:xxx }
备注	添加familyId 字段，age字段，createTime字段

8.查询家庭成员列表

Url	（Base_Url）/customer/ family/views
方法	Post
header	有
参数	无
成功返回		失败返回
{ “code”：0， “data”:[{ “avatarFileId”:”e05c0b70ae5c44bbb17d582de5663a0a”, “birth”:”1991-07-07″, “contactPhone”:””, “createTime”:”2017-01-05T16:40:53″, “familyId”:”0002050″, “familyName”:”原野“, “height”:172, “imagePath”:”http://file.machtalk.net:8090/group2/M00/02/5F/Cgq4YVhuCECEU4lEAAAAAET38Jc740.png”, “age”:26, “sex”:0, “weight”:64 },{ “avatarFileId”:”0c60f55eb39247b2ba2bae3f358fb097″, “birth”:”1945-01-01″, “contactPhone”:””, “createTime”:”2017-01-06T11:05:16″, “familyId”:”0002056″, “familyName”:”蓝精灵“, “height”:170, “imagePath”:”http://file.machtalk.net:8090/group1/M00/04/B4/CgqdrFh-z2iEUAtZAAAAAIL9RcA416.png”, “age”:72, “sex”:1, “weight”:60 }], “msg”：“操作成功” }		{ “code“: 1, “msg“:xxx }
familyId	家庭成员ID（String）
createTime	家庭成员创建时间（Sting）
age	年龄，根据出生日期计算（int）

9.修改家庭成员信息

Url	（Base_Url）/customer/ family/edit/{familyId}
方法	Post
header	有
参数	contactPhone	紧急联系人电话（String）
	familyName	家庭成员姓名（String）
	birth	出生日期（String）
	imagePath	头像地址（String）
	sex	性别（int 0.男 1.女）
	height	身高（int）
	weight	体重（int）
参数举例	{ “birth”:”1991-07-07″,” contactPhone”:””, “familyName”:”“, “height”:172, “imagePath”:”http://file.machtalk.net:8090/group2/M00/02/5F/Cgq4YVhuCECEU4lEAAAAAET38Jc740.png”, “sex”:0, “weight”:64 }
成功返回			失败返回
{ code：0， msg：“操作成功” }			{ “code“: 1, “msg“:xxx }

发布者：全栈程序员-站长，转载请注明出处：https://javaforall.net/225538.html原文链接：https://javaforall.net