56 lines
5.8 KiB
Python
56 lines
5.8 KiB
Python
# 班级api模块
|
|
from fastapi import APIRouter,Depends,HTTPException # 导入fastapi模块下的APIRouter,Depends,HTTPException
|
|
from schemas.class_schema import * # 从schemas包下的class_schema模块导入所有请求体、响应体
|
|
from core.database import get_db # 从core包下的database模块导入get_db上下文管理器，调用get_db函数可以自动开启关闭与数据库的会话
|
|
from dao.class_dao import * # 从dao包下的class_dao模块导入所有函数
|
|
|
|
# 实例化班级路由对象
|
|
classes_router = APIRouter()
|
|
|
|
|
|
#以下分别定义增、删、改、查的路由的接口函数，以便api接口函数中执行
|
|
|
|
# ————定义班级表"新增"信息的接口函数————
|
|
@classes_router.post('/',response_model=ClassResponse,summary='新增班级信息') # POST新增请求，指定返回数据格式为 ClassResponse
|
|
def post_classes(classes:ClassCreate,db=Depends(get_db)): # 定义更新接口函数，参数classes声明创建请求模型，参数db依赖于数据库会话的上下文管理器
|
|
c = classes.model_dump() # 变量c用来接收通过model_dump将Pydantic模型对象解析为Python的字典，方便后续解包传参
|
|
r = post_classes_dao( c , db ) # 变量r用来接收dao层post_classes_dao函数的返回值，执行函数时以变量c的数据和db依赖函数入参
|
|
if r : # 判断 DAO 层的返回结果，如果为True
|
|
return ClassResponse( total=1,data=c ) # 返回成功响应，携带新增的数据给前端
|
|
else : # 如果为False
|
|
raise HTTPException(status_code=500,detail='添加失败，服务器繁忙，请稍后添加！') # 抛出 500 内部服务器错误 和提示
|
|
|
|
|
|
# ————定义班级表"更新"信息的接口函数————
|
|
@classes_router.put('/{id}',response_model=ClassResponse,summary='更新班级信息') # put更新请求，指定返回数据格式为 ClassResponse
|
|
def put_classes( classes:ClassUpdate , id:int , db=Depends( get_db ) ): # 定义更新接口函数，id参数接收前端输入的数据，参数classes声明更新请求体模型，参数db依赖于数据库会话的上下文管理器
|
|
updates = classes.model_dump( exclude_unset=True ) # 变量updates用来接收通过model_dump将Pydantic模型对象解析为Python的字典(只解析输入的数据)，方便后续解包传参
|
|
r = update_classes_dao( id, db, updates ) # 变量r用来接收dao层update_classes_dao函数的返回值，执行函数时以变量c的数据、db依赖函数、和前端更新的数据入参
|
|
if r : # 判断 DAO 层的返回结果，如果为True
|
|
return ClassResponse( detail='更新成功', total=1 ,data = updates ) # 返回成功响应，携带更新的数据给前端
|
|
raise HTTPException( status_code=500, detail='更新失败，该班级已不存在或服务器繁忙，请稍后更新！' ) # 如果为False，抛出 500 内部服务器错误 和提示
|
|
|
|
|
|
# ————定义班级表"查询"信息的接口函数————
|
|
@classes_router.get('',summary='查询班级信息') # get查询请求
|
|
def get_classes( id:int|None = None # id参数接收前端输入的数据，声明是整数，可以为空默认为空
|
|
, class_no:str|None = None # class_no参数接收前端输入的数据，声明是字符串，可以为空默认为空
|
|
, class_name:str|None = None # class_name参数接收前端输入的数据，声明是字符串，可以为空默认为空
|
|
, page:int = 1 # page参数接收前端输入的数据，声明是整数，默认是1
|
|
, page_size:int = 5 # page参数接收前端输入的数据，声明是整数，默认是5
|
|
, db=Depends(get_db) # 参数db依赖于数据库会话的上下文管理器
|
|
):
|
|
t,r = get_classes_dao( id , class_no , class_name , page , page_size ,db ) # 变量t,r用来接收dao层get_classes_dao函数的返回值，执行函数时以前端输入的id , class_no , class_name , page , page_size 、db依赖函数入参
|
|
if t != 0 : # 判断 DAO 层的返回结果，如果为条数不为0
|
|
return ClassResponse( total = t, data = r ) # 返回成功响应，返回符合条件的总条数，携带符合条件的数据给前端
|
|
return ClassResponse( code = 404,detail = '没有符合条件的班级，请检查输入是否有误') # 判断 DAO 层的返回结果，如果为条数为0，返回404响应，提示没有符合条件的提示给前端
|
|
|
|
|
|
|
|
# ————定义班级表"删除"信息的接口函数————
|
|
@classes_router.delete('/{id}',response_model=ClassResponse,summary='删除班级信息') # delete删除请求，指定返回数据格式为 ClassResponse
|
|
def delete_classes(id:int,db=Depends(get_db)): # 定义删除接口函数，id参数接收前端输入的数据，参数db依赖于数据库会话的上下文管理器
|
|
r = delete_classes_dao( id , db ) # 变量r用来接收dao层delete_classes_dao函数的返回值，执行函数时以以前端输入的id 数据、db依赖函数入参
|
|
if r!=0 : # 判断 DAO 层的返回结果，如果是True
|
|
return ClassResponse( total=1,data='已成功删除班级信息' ) # 返回成功响应和提示给前端 # 如果是False
|
|
raise HTTPException(status_code=500, detail='删除失败，该班级信息已不存在或服务器繁忙，请稍后更新！') # 如果为False，抛出 500 内部服务器错误 和提示 |