用户模块-接口说明

用户模块-接口说明

一.用户模块概述

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

用户注册

用户登录

用户激活

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

找回密码

修改密码

二.事件定义

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	与err