教务管理系统接口规范文档1 简介
1.1 文档目的
接口文档是前端与后端交互密不可分的环节,接口的规范性会直接影响双方对接过程中的效率和质量。本着快速高效开发的目的性,避免对接过程中的错误率。由于前台处理数据能力较弱,故后台返回的数据尽可能便于前台使用。
1.2 接口规范
1) 遵循 RESTfulAPI 设计风格。
2) 数据格式采用 json 格式。
3) 返回统一结构数据。结构: datas(数据)、 code(状态码)、 msg(提示信息)。
4) 返回参数数据类型保持一致。
5) “操作类型”的接口必须返回 msg 信息内容。
6) 返回的展示型数据应具有可用性。
2 功能模块接口定义
2.1 用户登录
1) URL地址: http://localhost:8080/SomeSchoolInformation ManagementSystem/vue/userAction_login.action
2) 请求方式: POST
3) 请求参数:
参数名 类型 必填 示例值 默认值 描述
userid string Y 2017110301 空 学生 10 位,教师 8 位
password string Y pwd123456 空 不小于 6 位
vcodestring string YG1D2 空 验证码4) 接口返回:
A:登录成功:{
“code”: 200,
“msg”: “登录成功”,
“datas”: {
“token”: “JWT”
}
}
123456空必须包含字母数字和特殊符号,8到30 位vcodestringYG1D2空验证码4) 接口返回:
A:登录成功:{
“code”: 200,
“msg”: “登录成功”,
“datas”: {
“token”: “JWT”
}
总结
以上是教务管理系统接口规范文档1的简介和用户登录模块的接口定义。遵循RESTfulAPI设计风格和json数据格式,接口规范性高,返回统一结构数据。用户登录的请求参数包括userid、password和vcodestring,并且返回统一格式的信息。接口规范文档的制定有利于提高前后端对接的效率和质量,减少错误率,使得前端对数据的处理更加方便。