注册接口文档

注册接口文档

  1. 获取验证码接口

    1. 简要描述

      • 获取图片验证码
    2. 请求URL

      • http://192.168.56.100:8888/verify/image_codes/?uuid=a8c690ec-5590-49e2-8ae7-e00873ed8538  
        
    3. 请求方式:get

    4. 参数:访问接口携带参数

      • 参数名 必选 类型 说明
        uuid string 前端自己生成的uuid
    5. 返回事例

  2. 查询用户名/手机号是否存在

    1. 简要描述

      • 用户名或者手机号是否存在
    2. 请求URL

      • http://192.168.56.100:8888/user/count/
        
    3. 请求方式:POST

    4. 参数:访问接口携带参数

      • 请求接口事例

      • {
            "type":"phone",
            "data":18538752511
        }
        
      • 参数名 必选 类型 说明
        type string 验证类型:username/phone
        data string 手机号或者用户名
    5. 返回事例

      • {
            "code":0,
            "msg":"查询成功",
            "data":{
                "type":"phone",
                "count":1
            }
        }
        
    6. 返回参数说明

      • 参数名 类型 说明
        type string phone或者username
        data int 如果为0没有注册,如果大于0注册过
  3. 获取手机验证码

    1. 简要描述

      • 用户名或者手机号是否存在
    2. 请求URL

      • http://192.168.56.100:8888/user/count/
        
    3. 请求方式:POST

    4. 参数:访问接口携带参数

      • 请求接口事例

      • {
        "phone":"phone",
        "image_code":”a86d”,
        "image_code_uuid":”de8edce2-fc9f-11ea-9325-005056c00008”,
        }
        
        
      • 参数名 必选 类型 说明
        phone string 手机号
        image_code string 字符串验证码
        image_code_uuid string 前端生成的uuid
    5. 返回事例

      • {
        "code":0,
         "msg":"短信发送成功",
            "data":{
            
            }
        }
        
    6. 返回参数说明

      • 参数名 类型 说明
        code string 状态码
        msg string 提示信息
  4. 注册接口

    1. 简要描述

      • 用户注册接口
    2. 请求URL

      • http://192.168.56.100:8888/user/register/
        
    3. 请求方式:POST

    4. 参数:访问接口携带参数

      • 请求接口事例

      • {
            "username":"zhangsan",
        "password":”zs@qq.com”,
        "phone":”18538752511”,
        "code":”786543”
        }
        
      • 参数名 必选 类型 说明
        username string 用户名
        password string 密码
        phone string 用户手机号
        code string 短信验证码
    5. 返回事例

      • {
            "code":0,
            "msg":"注册成功",
            "data":{
        
            }
        }
        
    6. 返回参数说明

      • 参数名 类型 说明
        code string 状态码
        msg string 提示信息

原文地址:https://www.cnblogs.com/wyx-zy/p/13926978.html