目录
修订版本
1. 目的
2. 阅读人员
3. 参考文档
ll大学学生信息管理系统系统_学院管理_查询新增或修改删除标准接口
4.1 接口概述
4.2 接口名称
4.3查询学院信息接口标准
4.4新增学院信息接口标准
4.5修改学院信息接口标准
学生信息管理系统系统_学院管理_查询新增或修改删除标准接口需求接口V1.0
修订版本
Ver No. | Description | Author | Date |
版本编号 | 描述 | 作者 | 日期 |
V1.0 | 编制 | ahui | 2022-07-19 |
1. 目的
本文档是根据《中国高校联盟各个业务系统接口定义规范》要求设计的接口规范模版,用于指导各高校各个业务系统间接口的实施。
2. 阅读人员
Ø 业务需求人员
Ø 服务消费方的开发商
Ø 系统维护员
Ø 各业务系统接口负责人以及接口开发/维护/测试人员
3. 参考文档
《01:中国高校联盟系统接口定义规范》
ll大学学生信息管理系统系统_学院管理_查询新增或修改删除标准接口
4.1 接口概述
管理系统查询新增或修改删除学院信息需求的任务状态。
4.2 接口名称
大学学生信息管理系统系统_学院管理_查询新增或修改删除标准接口
4.3查询学院信息接口标准
根地址:http://127.0.0.1:8000
请求方法:get
4.3.1查询全部学院信息
项目 | 描述 | |
接口说明 | 查询全部的学院信息。 | |
输入参数 | /api/departments/ | |
返回结果 | URL 返回 数据 结构 | HTTP 200 OKAllow: GET, POST, DELETEContent-Type: application/jsonVary: Accept { "count": 50, "next": "http://127.0.0.1:8000/api/departments/?page=2", "previous": null, "results": [ { "dep_id": "T01", "dep_name": "Python学院", "master_name": "王院长", "slogan": "简洁" }, { "dep_id": "ghi", "dep_name": "??", "master_name": "Name1", "slogan": "hello" }, { "dep_id": "gkl", "dep_name": "java", "master_name": "Name1", "slogan": "hello" }, 。。。 ]} |
4.3.2查询指定学院信息
项目 | 描述 | |
接口说明 | 管理者用来查询指定的学院信息。 | |
输入参数 | /api/departments/T01/ |
学生信息管理系统系统_学院管理_查询新增或修改删除标准接口需求接口V1.0
4.4新增学院信息接口标准
根地址:http://127.0.0.1:8000
请求方法:post
4.4.1新增单个学院信息
项目 | 描述 | |
接口说明 | 新增单个学院信息。 | |
输入参数 | /api/departments/ | |
参数格式 | json格式 | |
参数示例 | { "data": [ { "dep_id":"T01", "dep_name":"Test学院", "master_name":"Test-Master", "slogan":"Here is Slogan" } ] } | |
新增成功返回结果 | URL成功 返回 数据 结构 | { "already_exist": { "results": [], "count": 0 }, "create_success": { "results": [ { "dep_id": "T02", "dep_name": "Java学院", "master_name": "Java-Master", "slogan": "java" } ], "count": 1 } } |
新增失败id已存在- | URL失败 返回 数据 结构 | { "already_exist": { "results": [ { "dep_id": "T01", "dep_name": "Test学院", "master_name": "Test-Master", "slogan": "Here is Slogan" } ], "count": 1 }, "create_success": { "results": [], "count": 0 } } |
新增失败json格式错误: | URL失败 返回 数据 结构 | { "status_code": 400, "detail": "请求体参数格式错误。" } |
4.4.2新增多个学院信息
项目 | 描述 | |
接口说明 | 新增多个学院信息。 | |
输入参数 | /api/departments/ | |
参数格式 | json格式 | |
参数示例 | 请求数据报文json(可新增多条,之间用,隔开),2个如下: { "data": [ { "dep_id": "T01", "dep_name": "Test学院", "master_name": "Test-Master", "slogan": "Here is Test Slogan" }, { "dep_id": "T02", "dep_name": "Java学院", "master_name": "Java-Master", "slogan": "Here is Java Slogan" }, ] } | |
新增成功返回结果 | URL成功 返回 数据 结构 | { "already_exist": { "results": [], "count": 0 }, "create_success": { "results": [ { "dep_id": "T02", "dep_name": "Java学院", "master_name": "Java-Master", "slogan": "java" } ], "count": 1 } } |
新增失败id已存在- | URL失败 返回 数据 结构 | { "already_exist": { "results": [ { "dep_id": "T01", "dep_name": "Test学院", "master_name": "Test-Master", "slogan": "Here is Slogan" } ], "count": 1 }, "create_success": { "results": [], "count": 0 } } |
新增失败json格式错误: | URL失败 返回 数据 结构 | { "status_code": 400, "detail": "请求体参数格式错误。" } |
4.5修改学院信息接口标准
根地址:http://127.0.0.1:8000
请求方法:put
4.5.1修改指定的学院信息
项目 | 描述 | |
接口说明 | 管理者用来修改指定的学院信息。 | |
特殊说明 | T03为学院ID,学院ID与数据中的dep_id的值必须一致 | |
输入参数 | /api/departments/T03/ | |
参数格式 | json | |
参数示例 | { "data": [ { "dep_id": "T03", "dep_name": "C++/学院", "master_name": "C++-Master", "slogan": "Here is Slogan" } ] } |
以下是我收集到的比较好的学习教程资源,虽然不是什么很值钱的东西,如果你刚好需要,可以评论区,留言【777】直接拿走就好了
各位想获取资料的朋友请点赞 + 评论 + 收藏,三连!
三连之后我会在评论区挨个私信发给你们~