API文档模板

接口说明：

• 登录接口

修订历史：

版本号	制定人	修订日期
0.0.2	zenghui	2017-09-27
0.0.1	zanshan	2017-02-20

URL:

• http://xxx.xx.com/api/login

请求方式：

• GET
• POST

Header：

参数名	是否必须	类型	说明
Content-Type	是	string	请求类型： application/json
Content-MD5	是	string	请求内容签名

请求参数:

参数名	是否必须	类型	说明
username	是	string	用户名
password	是	string	密码

请求示例:

    $.ajax({
      url: "api/login",
      dataType: "json",
      type : "GET",
	  params: {
         username: 'Minho',
		 password: 'abc'
      }
      success : function(r) {
        console.log(r);
      }
    });

返回示例:

正确时返回:

{
    "errcode": 0,
    "data": {
        "username": "Minho",
        "level": 0 ,
        "lastlogin": "1436864169"
    }
}

错误时返回:

{
    "errcode": 500,
    "errmsg": "invalid appid"
}

返回参数说明:

参数名	类型	说明
level	int	用户组id，0：超级管理员；2：普通用户
username	String	用户名
lastlogin	ts	上次登录时间

备注:

• 错误代码说明
• 更多