API需求文档

2016-05-28  本文已影响0人  南小不大宫

API需求文档统一

操作声明:接口由RESTFUL标准定义可选操作:
POST (创建)
GET (请求)
PUT (更新)
DELETE (删除)
返回对象格式(Json):
{
data: //请求正确则返回具体对象,数组或者字典,请求出错则为String,描述错误信息
statusCode: //返回状态编码,HTTP标准,一般200代表成功
}


APP接口需求描述:

  1. 登录接口:用户登录,换取Token
    请求参数:
       username(String): 用户名
       password(String): 密码
    获取数据:
       token(String) 用户令牌
       expired(Long):过期时间

  2. 注册接口:普通用户注册功能
    请求参数:
        mobile(String): 用户手机号
        password(String): 密码
        smsCode(String): 短信验证码
        nickName(String): 昵称
    获取数据描述:
        mobile(String): 用户手机号
        nickName(String): 昵称
        id(Long): 用户id

  3. 获取验证码接口: 用户手机
    请求参数:
       mobile(String): 用户手机号
    获取数据描述:
       Void(不需要返回数据)

上一篇下一篇

猜你喜欢

热点阅读