您的位置:首页 > 编程语言 > Java开发

2017.7.3 慕课网-Java从零打造企业级电商项目实战:for2 用户模块接口设计

2018-01-04 16:41 369 查看
疑问:

/get_user_info.do 和 /get_information功能上好像是一样的?

门户接口 /user

/login.do 登录

选项

说明

URL

/login.do

功能

登录

请求方式

post

请求参数

username,password

参数说明

必填:username,password

成功返回示例

{

"status": 0,

"msg": "登录成功",

"data": {

"id": 12,

"username": "aaa",

"email": "aaa@163.com",

"phone": null,

"role": 0,

"createTime": 1479048325000,

"updateTime": 1479048325000

}

}

失败返回示例

{

"status": 1,

"msg": "密码错误"

}

/register.do 注册

选项

说明

URL

/register.do

功能

注册

请求方式

post

请求参数

username,password,email,phone,question,answer

参数说明

username和email都不能重复;

必填:username,password

成功返回示例

{

"status": 0,

"msg": "注册成功"

}

失败返回示例

{

"status": 1,

"msg": "用户已存在"

}

/check_valid.do [b]检查用户名或邮箱是否有效
[/b]

选项

说明

URL

/check_valid.do

功能

检查用户名或邮箱是否有效

请求方式

post

请求参数

str,type

参数说明

type: username或email

成功返回示例

{

"status": 0,

"msg": "校验成功"

}

失败返回示例

{

"status": 1,

"msg": "用户已存在"

}

/get_user_info.do [b]获取用户信息
[/b]

选项

说明

URL

/get_user_info.do

功能

获取用户信息

请求方式

post

请求参数

参数说明

如果用户处于未登录状态,则无法获取。

成功返回示例

{

"status": 0,

"data": {

"id": 12,

"username": "aaa",

"email": "aaa@163.com",

"phone": null,

"role": 0,

"createTime": 1479048325000,

"updateTime": 1479048325000

}

}

失败返回示例

{

"status": 1,

"msg": "用户未登录,无法获取当前用户信息"

}

/forget_get_question.do [b]获取密码找回问题
[/b]

选项

说明

URL

/forget_get_question.do

功能

获取密码找回问题

请求方式

post

请求参数

username

参数说明

成功返回示例

{

"status": 0,

"data": "这里是问题"

}

失败返回示例

{

"status": 1,

"msg": "该用户未设置找回密码问题"

}

/forget_check_answer.do [b]提交找回密码问题的答案
[/b]

选项

说明

URL

/forget_check_answer.do

功能

提交找回密码问题的答案

请求方式

post

请求参数

username,question,answer

参数说明

正确的返回值里面有一个token,忘记密码后重置密码的时候需要用这个。

成功返回示例

{

"status": 0,

"data": "531ef4b4-9663-4e6d-9a20-fb56367446a5"

}

失败返回示例

{

"status": 1,

"msg": "问题答案错误"

}

/forget_reset_password.do [b]忘记密码状态下的重置密码
[/b]

选项

说明

URL

/forget_reset_password.do

功能

忘记密码状态下的重置密码

请求方式

post

请求参数

username,passwordNew,forgetToken

参数说明

forgetToken很重要。

成功返回示例

{

"status": 0,

"msg": "修改密码成功"

}

失败返回示例

{

"status": 1,

"msg": "修改密码操作失效"

}

/reset_password.do [b]登录状态下的重置密码
[/b]

选项

说明

URL

/reset_password.do

功能

登录状态下重置密码

请求方式

post

请求参数

passwordOld,passwordNew

参数说明

这里的凭证不需要forgetToken。

注意:这里还要校验旧密码是否正确。防止横向越权。

成功返回示例

{

"status": 0,

"msg": "修改密码成功"

}

失败返回示例

{

"status": 1,

"msg": "旧密码输入错误"

}

/update_information.do [b]登录状态下更新个人信息
[/b]

选项

说明

URL

/update_information.do

功能

登录状态下更新个人信息

请求方式

post

请求参数

email,phone,question,answer

参数说明

username不可以更改。

成功返回示例

{

"status": 0,

"msg": "更新个人信息成功"

}

失败返回示例

{

"status": 1,

"msg": "用户未登录"

}

/get_information.do [b]获取当前登录用户的详细信息
[/b]

选项

说明

URL

/get_information.do

功能

获取当前登录用户的详细信息,如果没有登录,强制登录。

请求方式

post

请求参数

参数说明

成功返回示例

{

"status": 0,

"data": {

"id": 1,

"username": "admin",

"password": "",

"email": "admin@163.com",

"phone": "13800138000",

"question": "question",

"answer": "answer",

"role": 1,

"createTime": 1478422605000,

"updateTime": 1491305256000

}

}

失败返回示例

{

"status": 10,

"msg": "用户未登录,无法获取当前用户信息,status=10,强制登录"

}

[b]/logout.do [b]退出登录
[/b][/b]

选项

说明

URL

/logout.do

功能

退出登录

请求方式

post

请求参数

参数说明

成功返回示例

{

"status": 0,

"msg": "退出成功"

}

失败返回示例

{

"status": 1,

"msg": "服务端异常"

}

后台用户接口 /manage/user

/login.do [b]后台管理员登录
[/b]

选项

说明

URL

/login.do

功能

后台管理员登录

请求方式

post

请求参数

username, password

参数说明

成功返回示例

{

"status": 0,

"data": {

"id": 12,

"username": "aaa",

"email": "aaa@163.com",

"phone": null,

"role": 0,

"createTime": 1479048325000,

"updateTime": 1479048325000

}

}

失败返回示例

{

"status": 1,

"msg": "密码错误"

}

内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: