[JavaScript知识库]用户模块-接口说明

用户模块-接口说明

一.用户模块概述

? 用户模块主要提供对于是用户使用本产品的基础。用户模块提供以下功能：

用户注册

用户登录

用户激活

用户收获地址新增/修改/删除/设为默认

找回密码

修改密码

二.事件定义

1. 用户激活

? 用户在注册的同时会同步发送用户激活的邮件。此激活邮件中存在用户激活的链接，用户通过点击此链接之后，在此页面内进行跳转到激活页面，此页面中有两个按钮，是否激活。用户点击激活之后，通过ajax发送激活请求。进行激活。

2. 用户地址管理

? 地址查询功能：在用户访问到地址页面时，此时会发送用户绑定的地址请求，全量返回有效的用户地址。

? 增加地址功能：用户可以提交新增地址，包括收货人、收件地址、地址标签、以及用户的联系方式，通过ajax提交。如果正常存储的话，此时回全量返回用户绑定的地址。

? 修改地址功能：用户可以修改有效地址中的收件人、收件地址、练习方式、以及地址标签。提交成功的话，回全量返回用户的地址。

? 删除地址功能：用户可以在界面上触发删除地址按钮，此时会将地址的ID通过ajax传入到后台，通过设置该地址的活跃属性来实现删除功能，此功能也是全量返回，然后通过渲染进行在前端展示。

? 设为默认地址：用户可以将任意一个非默认地址改为默认地址。通过ajax提交到后端，此功能提交的是地址的ID，将此ID的地址设置为默认，同时将此用户的其他地址ID设为非默认。然后进行全量返回。进行渲染。

3. 找回密码

? 用户在登陆页可以通过点击找回密码按钮来实现找回密码功能，主要分为三步。首先通过用户发送注册时的邮箱，此时会向邮箱中发送一份关于找回密码的验证码，此验证码会有时效。通过输入对应的验证码，验证没问题之后，显示设置新密码界面，提交之后就可以使用新密码进行登录。

4. 修改密码

? 修改密码功能需要在登录情况下进行，在个人账号管理页面中选择，需要输入旧密码以及新密码。通过ajax进行与后端交互。如果用户正确修改密码之后，则需要重新登陆。

三.API 说明

1. 用户注册功能API

用户注册功能API

• URL

  http://127.0.0.1:8000/v1/users

• 请求方法

  POST

• 请求参数

  JSON

  字段	含义	类型	备注
  uname	用户名	char	必填
  password	密码	char	必填
  phone	手机号	char	必填
  email	邮箱	char	必填
  carts	购物车中商品种类数量	int	必填

  请求示例

  {
      'uname':'zhaoliying',
      'password':'123456',
      'phone':'13603263333',
      'email':'zhaoliying@tedu.cn',
      'carts': '0'
  }
  

• 响应格式

  • 正确示例

    {
        'code': 200,
        'username': 'zhaoliying',
        'data': { 'token': token },
        'carts_count': 0
    }
    

  • 错误示例

    {
        'code': xxx,
        'error': 'error reason'
    }
    

• 响应数据说明

  字段	含义	类型	备注
  code	状态码	int	必填
  username	用户名	char	与error二选一
  data	返回数据[token]	dict	与error二选一
  carts_count	购物车商品种类数量	int	与error二选一
  error	错误原因	char	错误时填写

2. 用户登录功能API

用户登录功能API

• URL

  http://127.0.0.1:8000/v1/tokens

• 请求方法

  POST

• 请求参数

  JSON

  字段	含义	类型	备注
  username	用户名	char	必填
  password	密码	char	必填
  carts	购物车商品种类数量	int	必填

  请求示例

  {
      'username': 'zhaoliying',
      'password': '123456',
      'carts': 0
  }
  

• 响应格式

  • 正确响应示例

    {
        'code': 200,
        'username': 'zhaoliying',
        'data': { 'token': token },
        'carts_count': 0
    }
    

  • 错误响应示例

    {
        'code': xxx,
        'error': 'error reason'
    }
    

• 响应数据说明

  字段	含义	类型	备注
  code	状态码	int	必填
  username	用户名	char	与error二选一
  data	返回数据[token]	dict	与error二选一
  carts_count	购物车商品种类数量	int	与error二选一
  error	错误原因	char	错误时填写

3. 邮箱验证激活功能API

? 在用户注册时候，后台会给用户注册填写的邮箱发送一条激活的链接。通过点击链接跳转到达达商城的用户激活页面。通过激活来实现商城所有功能的体验。

3.1 事件触发

? 用户在注册时候会通过邮箱给用户发送一封激活邮件，然后用户通过点击链接，进行重定向到前端地址，此时通过js获取用户前端页面的查询字符串，进行激活。

页面名： register.html

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-o8KU3Lpa-1634386395602)(images/WX20191124-214045.png)]

3.2 触发结果

正常结果：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-67T7yRey-1634386395603)(images/WX20191124-211639.png)]

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-KqXtOCaC-1634386395604)(images/WX20191124-213112.png)]

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-p4BHkgy0-1634386395604)(images/WX20191124-213433.png)]

跳转激活页面：

页面地址： xxx/xxx/active.html

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-XxruOBhQ-1634386395605)(images/WX20191124-213600.png)]

异常结果：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-w4Y4PReY-1634386395605)(images/WX20191124-214504.png)]

URL：http://127.0.0.1:8000/v1/users/activation?code=xxxx

请求方法：GET

请求参数：JSON

返回值：JSON

响应格式：

# 正常响应
{
  'code': 200,
  'data': '激活成功'
}
# 异常响应
{
  'code':xxx,
  'error':'error_reason'
}

4. 地址管理功能API

4.1 地址功能说明

达达商城提供地址增删改查设为默认的功能：

? 查询功能：在用户请求的地址管理页面的时候，等页面主体加载完之后，会发送查询当前用户的绑定地址。返回当前用户绑定的所有地址。

? 增加地址功能：用户可以新增绑定地址。

? 修改地址功能：可以修改用户地址中的任何字段。

? 删除地址功能：可以删除用户所绑定的地址，不是真正的删除，而是在后台将地址改为非活跃的。

? 设为默认地址：用户可以将任意一个非默认地址改为默认地址。默认地址在用户完成付款之前会直接绑定到该订单上。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-v4IuHOfA-1634386395606)(images/WX20191127-103812.png)]

4.2 查询地址

URL:http://127.0.0.1:8000/v1/users/<username>/address

4.2.1 事件出发

页面名：addressAdmin.html

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-JyhCQ5lx-1634386395606)(images/WX20191124-215254.png)]

4.2.2 触发结果

? 正常响应：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-7d2wlJIv-1634386395607)(images/WX20191124-220115.png)]

? 异常响应：

? 如果用户没有登陆的访问到地址页面，此时会弹出用户登陆提示，然后跳到登陆页面。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Fa1FR748-1634386395607)(images/WX20191125-150939@2x.png)]

请求方法：GET

返回数据：在访问页面的时候，返回当前用户的所有地址

返回值：JSON

响应格式：

# 正常数据返回
{
  "code":200,
   "addresslist":[
      {
        'id':123456, # 地址id
        'address':'河北省石家庄市裕华区幸福快乐大厦1166室'， # 地址
        'receiver'：'达内科技'， # 收货人
        'receiver_mobile'：'12345678901', # 联系电话
        'tag':'家'，# 地址标签
        'postcode':'722494',  #
        'is_default':"True",
      },
      {
         'id':123457,
        'address':'河北省石家庄市桥东区编程大厦1188室'，
        'receiver'：'达内科技'，
        'receiver_mobile'：'12345678910',
        'tag':'公司'，
        'postcode':'722406',
        'is_default':"False",
      }
    ]
}
# 异常数据返回类型：
{
  'code': status_code,
  'error':'error_reason'
}

4.3 新增地址

4.3.1 事件触发

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-1PXOM7bi-1634386395607)(images/WX20191125-091831@2x.png)]

4.3.2 触发结果

? 正常结果：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-yHLx2vqV-1634386395608)(images/WX20191125-091954@2x.png)]

? 异常结果：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-AOqCJ3YS-1634386395608)(images/WX20191125-092143@2x.png)]

URL:http://127.0.0.1:8000/v1/users/<username>/address

请求方法：POST

请求参数：JSON

请求示例

{
  'receiver':'小王'，
  'receiver_phone':'18667018590',
  'address':'北京市东城区珠市口大街珍贝大厦2楼',
  'postcode':'722405',
  'tag':'公司'
}

返回值：JSON

响应格式：

# 正常响应
{
  "code":200,
  "data":"新增地址成功！"
}
# 异常响应
{
  'code': status_code,
  'error':'error_reason'
}

4.4 删除地址

4.4.1 事件触发

页面名：addressAdmin.html

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-kFCV3VRS-1634386395608)(images/WX20191125-094403@2x.png)]

4.4.2 触发结果

正常触发:

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-O4MOvFiE-1634386395608)(images/WX20191125-094523@2x.png)]

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-CYkYzrv5-1634386395609)(images/WX20191125-094621@2x.png)]

URL:http://127.0.0.1:8000/v1/users/<username>address/<id>

请求方法：DELETE

请求参数: JSON

{
  'id':'xxxxxx'
}

返回值：JSON

响应格式：

# 正常响应
{
  "code":200,
   "data":"删除地址成功"
}
# 异常响应：
{
  'code':xxxx,
  'error':'error_reason'
}

4.5 修改地址

4.5.1 事件触发

页面名：addressAdmin.html

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-5ppqHEjH-1634386395609)(images/WX20191125-095319@2x.png)]

4.5.2 触发结果

正常响应

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-ooRyrxk9-1634386395609)(images/WX20191125-095555@2x.png)]

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-mRS89BFn-1634386395609)(images/WX20191125-095813@2x.png)]

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-gkoavt1D-1634386395610)(images/WX20191125-100000@2x.png)]

异常响应

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-yW5X46w9-1634386395610)(images/WX20191125-100137@2x.png)]

URL:http://127.0.0.1:8000/v1/users/<username>/address/<id>

请求方式：PUT

请求参数：JSON

请求示例：

{
  'receiver':'校长',
  'receiver_phone':'18667018590'，
  'address':'广东省深圳市龙华区民治大道100号',
  'tag':'公司',
}

返回值：JSON

响应格式：

# 正常响应
{
  "code":200,
  "data":"地址修改成功！"
}

# 异常响应
{
    "code": xxx,
     'error':'error_reason'
}

4.6 设为默认地址

4.6.1 事件触发

页面名：addressAdmin.html

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-C0zkUa8l-1634386395610)(images/WX20191125-102252@2x.png)]

4.6.2 触发结果

正常触发

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-WiqSh7r4-1634386395610)(images/WX20191125-102356@2x.png)]

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-9gZQ5JMl-1634386395610)(images/WX20191125-102449@2x.png)]

URL：http://127.0.0.1:8000/v1/users/address/<username>/default

请求类型：POST

请求示例

{
  'id':'xxxxxxx'
}

返回值：JSON

响应格式：

# 正常响应
{
  "code":200,
  "data":"设为默认成功！"
}
# 异常响应
{
  'code':xxx,
  'error':'error_reason'
}

5. 修改密码

在登录的状态下才能够修改用户登录密码。

5.1 事件触发

页面名： personal_password.html

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-llJpiy9W-1634386395611)(images/WX20191124-201357.png)]

5.2 触发结果

? 触发成功：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-uqYC0YZy-1634386395611)(images/1574586866845.jpg)]

? 触发失败：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-jPQkUQmM-1634386395611)(images/WX20191124-171200@2x.png)]

修改密码API：

URL: http://127.0.0.1:8000/v1/users/<username>/password

请求方法：POST

请求参数：JSON

请求示例：

{
  'oldpasword':'123456',
  'password1':'123321',
  'password2':'654321'
}

返回值：JSON

响应格式：

# 正确示例
{
  'code':200,
  'data':'修改成功'
}
# 错误示例
{
  'code':xxx,
  'error':'error reason'
}

6. 找回密码功能

时序图

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-qMHDIHD4-1634386395611)(images/WX20191127-104632.png)]

6.1 发送邮箱验证请求

6.1.1 事件触发

页面名： findPass.html

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-jSJlrfYm-1634386395611)(images/WX20191124-201908.png)]

6. 1.2 触发结果

邮箱中可以收到后台发送的邮箱验证码（10分钟之内有效）：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-bG8apzRi-1634386395611)(images/1574598497022.jpg)]

触发失败：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-hsdMalbx-1634386395612)(images/WX20191124-203937.png)]

发送邮箱验证

URL：http://127.0.0.1:8000/v1/users/password/sms

请求方法：POST

请求参数：JSON

请求示例：

{
	'email':xxxxx # 邮箱
}

响应数据

返回值：JSON

响应格式：

# 正常响应
{
  'code':200,
  'data':"邮件发送成功",
}
# 异常响应
{
  'code':xxx,
  'error':'error reason'
}

6.2 发送邮箱验证码

6.2.1 事件触发

页面名： findPass.html

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-AfI5SHRb-1634386395612)(images/WX20191124-203134.png)]

6.2.2 触发结果

正常结果：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-CPOlKUJ6-1634386395612)(images/WX20191125-142700@2x.png)]

异常结果：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-vpUOWVa3-1634386395612)(images/WX20191124-204534.png)]

发送邮箱验证码：

URL：http://127.0.01:8000/v1/users/password/verification/

请求方法： POST

请求参数：JSON

{
  'email':'xxxx',
  'code':'xxxx'
}

响应数据：

返回值：JSON

响应格式：

# 正常响应
{
  'code':200,
 	'data':'验证码通过'，
  'email'：'xxxx' # 返回邮箱
}
# 异常响应
{
  'code':xxx,
  'error':'error reason'
}

6.3 修改密码

6.3.1 事件触发

页面名： findPass.html

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-wD6FHTDZ-1634386395613)(images/WX20191125-113421@2x.png)]

6.3.2 触发结果

正常响应

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-5wFcFnwX-1634386395613)(images/WX20191125-114042@2x.png)]

异常响应：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-PGBrxukV-1634386395613)(images/WX20191125-114319@2x.png)]

修改密码：

URL：http://127.0.0.1:8000/v1/users/password/new

请求方法：POST

请求参数：JSON

请求i示例

{
	"email":"xxx",    # 通过用户邮箱锁定用户
  'password1':'xxx' # 新密码
  'password2':'xxx' # 确认密码
}

响应数据：

返回值：JSON

响应格式：

# 正常数据
{
  'code':200,
  'data':'OK'
}
#  异常数据
{
  'code':xxx,
  'error':'error reason'
}

附录：用户模块异常状态码参考：