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:系统繁忙，数据库操作失败了（极小概率出现该结果）。

栗子（修改密码成功）：

系统功能模块接口文档相关推荐

拉钩教育课程管理系统接口文档
课程管理模块接口文档课程信息模块接口 1. 接口1 查询课程列表信息名称: findCourseList 描述: 查询课程列表信息 URL: http://localhost:8080/lagou ...
教育平台项目后台管理系统：接口文档
课程管理模块接口文档课程信息模块接口接口 1:查询课程列表信息名称: findCourseList 描述: 查询课程列表信息 URL: http://localhost:8080/lagou_e ...
仿抖音短视频用户业务模块----完成用户信息增删改查并通过接口文档联调（模拟工作环境）
仿抖音项目持续更新中: 仿抖音短视频APP专栏练习: 目录 1.根据nickname或者mobile来查询用户信息 2.根据用户id删除用户信息 3.根据用户id修改用户信息 1.根据nicknam ...
Swagger 生成 PHP restful API 接口文档
需求和背景需求: 为客户端同事写接口文档的各位后端同学,已经在各种场合回忆了使用自动化文档工具前手写文档的血泪史. 我的故事却又不同,因为首先来说,我在公司是 Android 组负责人,属于上述血泪 ...
对接接口文档_接口自动化测试框架设计思路
接口自动化测试--框架设计思路 1 前言之前文章跟大家分享了一下自己在接口自动化测试中进行测试准备的一些相关知识点,接下来本篇文章详细分享一下接口自动化框架设计的思路总结,希望能对初次探索接口自动化 ...
SpringBoot 使用Swagger2打造在线接口文档（附源代码）
点击上方"好好学java",选择"置顶公众号" 优秀学习资源.干货第一时间送达! 精彩内容 java实战练习项目教程 2018微服务资源springboot.s ...
SpringBoot 配置 generator代码生成+knife4j接口文档（2种模板设置、逻辑删除、字段填充含代码粘贴可用）保姆级教程（注意事项+建表SQL+代码生成类封装+测试类）
保姆级教程,逻辑删除及字段自动填充设置,特别要说明的是本次用的是MySQL数据库,如果使用Oracle数据库是,数据库配置需要改变,数据库表一定要大写,否则无法生成代码. 数据库表 CREATE TA ...
Django框架深入了解_05 (Django中的缓存、Django解决跨域流程(非简单请求，简单请求)、自动生成接口文档)(二)
二.跨域: 回到顶部跨域知识介绍: 点我以前博客跨域解决方法:CORS:跨域资源共享 CORS请求分类(简单请求和非简单请求) 简单请求(simple request):只需要在头信息之中增加一个 ...
Django框架深入了解_05 (Django中的缓存、Django解决跨域流程(非简单请求，简单请求)、自动生成接口文档)(一)
阅读目录一.Django中的缓存: 前戏: Django中的几种缓存方式: Django中的缓存应用: 二.跨域: 跨域知识介绍: CORS请求分类(简单请求和非简单请求) 示例: 三.自动生成接口 ...

系统功能模块接口文档