1ll大学学生信息管理系统系统_学院管理_查询新增或修改删除标准接口_

目录

修订版本

[1. 目的](#1. 目的)

[2. 阅读人员](#2. 阅读人员)

[3. 参考文档](#3. 参考文档)

ll大学学生信息管理系统系统_学院管理_查询新增或修改删除标准接口

[4.1 接口概述](#4.1 接口概述)

[4.2 接口名称](#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】直接拿走就好了

各位想获取资料的朋友请 点赞 + 评论 + 收藏 ,三连!

三连之后我会在评论区挨个私信发给你们~

相关推荐
冷雨夜中漫步7 小时前
Python快速入门(6)——for/if/while语句
开发语言·经验分享·笔记·python
郝学胜-神的一滴8 小时前
深入解析Python字典的继承关系:从abc模块看设计之美
网络·数据结构·python·程序人生
百锦再8 小时前
Reactive编程入门:Project Reactor 深度指南
前端·javascript·python·react.js·django·前端框架·reactjs
m0_736919109 小时前
C++代码风格检查工具
开发语言·c++·算法
喵手9 小时前
Python爬虫实战:旅游数据采集实战 - 携程&去哪儿酒店机票价格监控完整方案(附CSV导出 + SQLite持久化存储)!
爬虫·python·爬虫实战·零基础python爬虫教学·采集结果csv导出·旅游数据采集·携程/去哪儿酒店机票价格监控
2501_944934739 小时前
高职大数据技术专业,CDA和Python认证优先考哪个?
大数据·开发语言·python
helloworldandy9 小时前
使用Pandas进行数据分析:从数据清洗到可视化
jvm·数据库·python
发现一只大呆瓜10 小时前
前端性能优化:图片懒加载的三种手写方案
前端·javascript·面试
可可南木10 小时前
3070文件格式--15--bootptab文件
功能测试·测试工具·pcb工艺
黎雁·泠崖10 小时前
【魔法森林冒险】5/14 Allen类(三):任务进度与状态管理
java·开发语言