introduction.md

文档使用说明

1.1 版本历史

日期	版本号	作者	备注
2017.5.12	1.0	MinHow	新版本发布

1.2 文档介绍

  本文档的接口遵循RESTful设计风格...。

1.3 接口约定

1.3.1 登录认证流程

  基于JWT认证机制，实现登录认证流程...。

1.3.2 Token 验证

Token访问有效期为两个小时，刷新有效期为两周...。

注意事项：...。

1.3.3 返回结果

所有返回结果以 JSON 格式返回；接口返回一共有三种情况：

1. 操作成功后返回，范例：

{
  "code": "200",//状态码
  "msg": "SUCCESS"//信息
} 

2. 成功返回数据，范例：

{
  "data": {//数据
    "name": "minhow",
    "age": "18"
  },
  "code": "200",//状态码
  "msg": "SUCCESS"//信息
}

3. 错误返回，范例：

{
  "err_code": "1001",//错误状态码
  "err_msg": "认证失败，请重新登录！"//错误信息
}

1.3.4 全局响应状态码说明

状态码	说明
200	操作成功
1001	认证失败，请重新登录！
1002	参数不合法！