学生BS端接口说明书1

preview
需积分: 0 0 下载量 68 浏览量 更新于2022-08-08 收藏 101KB DOCX 举报
本文档主要介绍了学生B/S端接口的使用,涉及到网络协议、服务器以及软件/插件的相关知识。接口主要用于学生信息的管理,包括修改信息、提交请假条和查看历史请假条等功能。 1. **接口说明** - 接口遵循HTTP协议,请求内容类型为`Content-Type: application/javascript`。 - 错误码部分详细列出了常见的HTTP错误码,如400、401、403、404等,这些错误码代表了不同的请求问题或服务器响应状态。 2. **/Ajavaspirit/student/contact - 修改信息** - **1.2.1 请求地址**:`/Ajavaspirit/student/contact`,使用GET方法,无需登录。 - **1.2.2 请求说明**:请求需要包含旧密码和新密码,参数类型为JSON,例如:`{"username": "栾晓玥", "password": "1111", "password1": "0000"}`。 - **响应参数**:返回Status Code(响应码)和响应信息,成功时返回200,并附带更新后的用户名和密码信息。 3. **/Ajavaspirit/student/qingjia - 提交请假条** - **1.3.1 请求地址**:`/Ajavaspirit/student/qingjia`,使用GET方法,需要登录。 - **1.3.2 请求说明**:请求需包含课程名、教师姓名和请假条图片路径,例如:`{"course": "大数据", "tea": "王伟", "file": "timg01.jpg"}`。 - **响应参数**:返回Status Code和响应信息,成功时返回200,包含学生姓名、课程名、教师姓名和请假条图片路径。 4. **/Ajavaspirit/student/papers - 查看历史请假条** - **1.4.1 请求地址**:`/Ajavaspirit/student/papers`,使用GET方法,需要登录。 - **1.4.2 请求说明**:无特定请求参数,响应中包含上传时间、审核状态和请假条图片路径。 - **响应参数**:返回Status Code,成功时返回200,包含请假条的上传时间、审核状态和图片路径。 5. **错误码说明** - 在接口操作中,错误码用于标识请求失败的原因,如400表示请求有语法问题,401表示未授权,201表示没有找到对应的课程或老师,202表示文件大小超过限制。 6. **注意事项** - 请求参数的完整性至关重要,如密码字段不能为空,课程名和任课老师也需要提供。 - 文件大小有限制,超过规定大小将导致请求失败。 - 接口的调用需要符合HTTP协议规范,包括正确的请求方法、请求头和请求体内容。 总结来说,这个学生B/S端接口是基于HTTP协议的,通过GET请求进行信息交互,涉及用户身份验证、信息修改、请假申请和历史记录查看等功能。正确理解和使用这些接口,对于学生与服务器之间的数据交换至关重要。同时,要关注错误码,以便在出现问题时能快速定位和解决。