Skip to content

highdsa RESTful接口文档

Jump to bottom
Husen edited this page May 17, 2018 · 9 revisions

完整URL为：http://ip:端口/项目名称/rest_url?param1=value1&param2=value2?...

项目名称：highdsa-restful-app

rest_url：为以下接口文档中的URL

1. 测试是否登录

  • 接口功能：测试是否登录
  • HTTP方法：GET
  • 请求URL：/app/v1/hello
  • 请求参数：无
  • 返回结果示例
{
    "login": false
}
  • 说明
成功返回true,未登录返回false

2. 使用用户名和密码登录

  • 接口功能：登录
  • HTTP方法：POST
  • 请求URL：/app/v1/login/username
  • 请求参数：
参数名称 参数类型 默认值 说明
username String - 用户名（不含中文，与用户昵称区别开）
password String - 密码
  • 返回结果示例
{
    "success": true,
    "message": {
        "data": {
            "mobi": "18626422426",
            "id": 1000,
            "logo_url": "https://image.husen.com/sys/v1/user/1000",
            "email": "[email protected]",
            "username": "天哥"
        },
        "token": "269e4ce1-7f29-475b-a807-0d397885ac36"
    }
}
  • 说明
成功success为true,message为相应信息
失败success为false,message为相应信息

3. 使用手机和密码登录

  • 接口功能：登录
  • HTTP方法：POST
  • 请求URL：/app/v1/login/phone
  • 请求参数：
参数名称 参数类型 默认值 说明
phone String - 手机号(不含86等国家编码)
password String - 密码
  • 返回结果示例
{
    "success": true,
    "message": {
        "data": {
            "mobi": "18626422426",
            "id": 1000,
            "logo_url": "https://image.husen.com/sys/v1/user/1000",
            "email": "[email protected]",
            "username": "天哥"
        },
        "token": "269e4ce1-7f29-475b-a807-0d397885ac36"
    }
}
  • 说明
成功success为true,message为相应信息
失败success为false,message为相应信息

4. 使用邮箱和密码登录

  • 接口功能：登录
  • HTTP方法：POST
  • 请求URL：/app/v1/login/email
  • 请求参数：
参数名称 参数类型 默认值 说明
email String - 邮箱地址
password String - 密码
  • 返回结果示例
{
    "success": true,
    "message": {
        "data": {
            "mobi": "18626422426",
            "id": 1000,
            "logo_url": "https://image.husen.com/sys/v1/user/1000",
            "email": "[email protected]",
            "username": "天哥"
        },
        "token": "269e4ce1-7f29-475b-a807-0d397885ac36"
    }
}
  • 说明
成功success为true,message为相应信息
失败success为false,message为相应信息

5. 退出登录

  • 接口功能：退出登录，清除会话缓存和持久化

  • HTTP方法：POST

  • 请求URL：/app/v1/logout

  • 请求参数：无

  • 返回结果示例

{
    "success": true,
    "message": "退出登录成功"
}
  • 说明
成功success为true,message为相应信息
失败success为false,message为相应信息

6. 注册

  • 接口功能：注册创建新用户
  • HTTP方法：POST
  • 请求URL：/register/v1/user
  • 请求参数：
参数名称 参数类型 默认值 说明
user_phone String - 手机号
user_password String - 密码
  • 返回结果示例
{
    "success": true,
    "message": "用户1862642242627"
}
  • 说明
成功success为true,message为默认创建的用户名
失败success为false,message为相应信息

7. 发送验证码

  • 接口功能：发送验证码到指定手机号
  • HTTP方法：POST
  • 请求URL：/sms/v1/captcha
  • 请求参数：
参数名称 参数类型 默认值 说明
phone_number String - 手机号（不含86等国家编码）
  • 返回结果示例
{
    "success": false,
    "message": "806457"
}
  • 说明
成功success为true,message为验证码
失败success为false,message为相验证码

8. 校验验证码

  • 接口功能：发送验证码到指定手机号
  • HTTP方法：POST
  • 请求URL：/sms/v1/validate
  • 请求参数：
参数名称 参数类型 默认值 说明
phone_number String - 手机号
captcha String - 验证码
  • 返回结果示例
{
    "success": true,
    "message": "手机验证成功"
}
  • 说明
成功success为true,message为相应信息
失败success为false,message为相应信息

9. 找回密码

  • 接口功能：校验验证码，重置密码
  • HTTP方法：PUT
  • 请求URL：/app/v1/password
  • 请求参数：
参数名称 参数类型 默认值 说明
phone_number String - 手机号
captcha String - 验证码
new_password String - 新密码
  • 返回结果示例
{
    "success": true,
    "message": "修改密码成功"
}
  • 说明
成功success为true,message为相应信息
失败success为false,message为相应信息

10. 根据手机号获取用户信息

  • 接口功能：获取用户信息
  • HTTP方法：GET
  • 请求URL：app/v1/user/info/phone
  • 请求参数：
参数名称 参数类型 默认值 说明
phone_number String - 手机号
  • 返回结果示例
{
    "success": true,
    "message": {
        "userId": 1000,
        "userNickName": "天哥",
        "userRegisterTime": 1523605040885,
        "userHeadUrl": "https://image.husen.com/sys/v1/user/1000",
        "userSex": true,
        "userAddress": null,
        "userAge": null,
        "userBirthday": "19950810",
        "userDesc": "客户1000",
        "userLastLoginTime": 1523605040885
    }
}
  • 说明
成功success为true,message为相应用户信息实体类
失败success为false,message为相应信息

11. 根据用户名获取用户信息

  • 接口功能：获取用户信息
  • HTTP方法：GET
  • 请求URL：app/v1/user/info/username
  • 请求参数：
参数名称 参数类型 默认值 说明
username String - 用户名
  • 返回结果示例
{
    "success": true,
    "message": {
        "userId": 1000,
        "userNickName": "天哥",
        "userRegisterTime": 1523605040885,
        "userHeadUrl": "https://image.husen.com/sys/v1/user/1000",
        "userSex": true,
        "userAddress": null,
        "userAge": null,
        "userBirthday": "19950810",
        "userDesc": "客户1000",
        "userLastLoginTime": 1523605040885
    }
}
  • 说明
成功success为true,message为相应用户信息实体类
失败success为false,message为相应信息
Clone this wiki locally