SIA-系统模块接口文档
框图结构:
登录模块
1 数据库的设计
1.1.tb_admin(管理员信息)
字段信息:
id
:作为主键存在,管理员编号。
username
:用户名,管理员登录所用。
password
:密码,管理员登录校验所用。
2.2.tb_member(成员信息)
字段信息:
id
:用户编号,作为主键使用。
username
:用户名,登录所用。
password
:密码,登录校验所用。
realname
:真实姓名,实名制。
groupId
:组别编号,说明其隶属哪个组。
clazz
:班级信息,说明其属于哪个班。
2.登录接口
请求方式:post
请求路径:/sia/system/login
前端需要向后台传以下参数:
username
用户名 name=“username”
password
密码 name=“password”
status
身份 (单选框)name=“status” value1=“admin” value2=“member”
后端返回一个结果封装类,其中有四个信息code(响应编码),msg(提示信息),count(返回结果个数),info(登录成功后的用户信息)
其中code值有以下含义:
code 4001
:用户名长度应为1~16,不符合要求。
code 4002
:用户密码应为6~16,不符合要求。
code 4003
:用户未选择身份信息。
code 4005
:用户名或密码不正确。
code 1001
:登录成功。
栗子(登录成功):
3.修改密码接口
请求方式:post
请求路径:/sia/system/modifyPwd (注意P大写)
前端需要传给后台以下参数:
username
用户名,用于校验身份。
password
原密码,用于校验身份。
status
身份,用于校验身份。
newPwd
新密码。
后台同样返回一个结果封装类,同上登录。
其中code值的含义如下:
code 1001
:修改密码成功。
code 4002
:新密码长度6~16位,不符合规范。
code 4004
:系统繁忙,数据库操作失败了(极小概率出现该结果)。
栗子(修改密码成功):