FastAPI(六)统一返回值

分手后的思念是犯贱 2024-03-27 16:35 90阅读 0赞

**目录**

一、在根目录新建common文件夹、在common文件夹新建error\_code.py和resp.py

二、API返回值

三、序列化问题

--------------------

#### 一、在根目录新建common文件夹、在common文件夹新建error\_code.py和resp.py ####

# error_code.py
    from pydantic import BaseModel
    
    
    class ErrorBase(BaseModel):
        code: int
        msg: str = ""
    
    
    # 找不到路径
    ERROR_NOT_FOUND = ErrorBase(code=404, msg="api 路径错误")
    # 参数错误
    ERROR_PARAMETER_ERROR = ErrorBase(code=400, msg="参数错误")
    
    # 用户相关
    ERROR_USER_TOKEN_FAILURE = ErrorBase(code=5004, msg="未登录或登录过期")
    ERROR_USER_NOT_FOUND = ErrorBase(code=5004, msg="用户不存在")
    ERROR_USER_PASSWORD_ERROR = ErrorBase(code=5005, msg="密码错误")
    ERROR_USER_NOT_ACTIVATE = ErrorBase(code=5006, msg="用户账号尚未")
    ERROR_USER_ACCOUNT_EXISTS = ErrorBase(code=5007, msg="账号已存在")
    ERROR_USER_EMAIL_NOT_EXISTS = ErrorBase(code=5008, msg="邮箱不存在")
    ERROR_FORGET_PWD_TOKEN_ERROR = ErrorBase(code=5009, msg="重置密码链接错误或已过期")
    ERROR_USER_REGISTER_TOKEN_ERROR = ErrorBase(code=5031, msg="注册验证链接已过期或不存在")
    ERROR_USER_REGISTER_EXISTS = ErrorBase(code=5032, msg="注册失败，可能账号已存在。")
    ERROR_USER_REGISTER_ERROR = ErrorBase(code=5033, msg="注册失败，请重试。")
    ERROR_USER_REGISTER_TO_OFTEN = ErrorBase(code=5034, msg="提交注册太频繁，请稍后重试")
    ERROR_USER_EMAIL_EXISTS = ErrorBase(code=5011, msg="邮箱不可用")
    ERROR_USER_PHONE_EXISTS = ErrorBase(code=5012, msg="手机号码不可用")
    ERROR_USER_USERNAME_EXISTS = ErrorBase(code=5013, msg="用户名不可用")
    ERROR_USER_CAPTCHA_CODE_ERROR = ErrorBase(code=5021, msg="验证码错误")
    ERROR_USER_CAPTCHA_CODE_INVALID = ErrorBase(code=5022, msg="验证码已失效，请重试。")
    ERROR_USER_PREM_ADD_ERROR = ErrorBase(code=5031, msg="权限标识添加失败")
    ERROR_USER_PREM_ERROR = ErrorBase(code=5403, msg="权限不足")

# resp.py
    from fastapi import status
    from fastapi.responses import JSONResponse  # , ORJSONResponse
    from pydantic import BaseModel
    from typing import Union, Optional
    
    from common.error_code import ErrorBase
    
    
    class respJsonBase(BaseModel):
        code: int
        msg: str
        data: Union[dict, list]
    
    
    def respSuccessJson(data: Union[list, dict, str] = None, msg: str = "Success"):
        """ 接口成功返回 """
        return JSONResponse(
            status_code=status.HTTP_200_OK,
            content={
                'code': 0,
                'msg': msg,
                'data': data or {}
            }
        )
    
    
    def respErrorJson(error: ErrorBase, *, msg: Optional[str] = None, msg_append: str = "",
                      data: Union[list, dict, str] = None, status_code: int = status.HTTP_200_OK):
        """ 错误接口返回 """
        return JSONResponse(
            status_code=status_code,
            content={
                'code': error.code,
                'msg': (msg or error.msg) + msg_append,
                'data': data or {}
            }
        )

#### 二、API返回值 ####

from fastapi import APIRouter, Depends
    from sqlalchemy.orm import Session
    
    from apps.user.crud import user_crud
    from apps.user.schemas.user_schemas import Item
    from common import error_code
    from common.resp import respSuccessJson, respErrorJson
    from db.session import get_db
    
    router = APIRouter()
    
    
    @router.post("/login", summary="用户登录", tags=['用户'])
    async def login(item: Item, db: Session = Depends(get_db)):
        user = user_crud.getByUsername(db=db, username=item.username)
        if user:
            d: dict = user.__dict__
            del d['_sa_instance_state']
            return respSuccessJson(data=d, msg='获取成功')
        else:
            return respErrorJson(error=error_code.ERROR_USER_USERNAME_EXISTS)

#### 三、序列化问题 ####

接口返回SQLAlchemy对象时会返回空对象。参考我另一篇博文

[SQLAlchemy对象转字典，解决SQLAlchemy对象返回为空的问题\_苍穹之跃的博客-CSDN博客【代码】SQLAlchemy对象转字典，解决SQLAlchemy对象返回为空的问题。![favicon32.ico][]https://blog.csdn.net/wenxingchen/article/details/129078831?spm=1001.2014.3001.5501][SQLAlchemy_SQLAlchemy_-CSDN_SQLAlchemy_SQLAlchemy_favicon32.ico_https_blog.csdn.net_wenxingchen_article_details_129078831_spm_1001.2014.3001.5501]

[favicon32.ico]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/93d0d4c85ce849bfb4eb55f4b15863cd.png
[SQLAlchemy_SQLAlchemy_-CSDN_SQLAlchemy_SQLAlchemy_favicon32.ico_https_blog.csdn.net_wenxingchen_article_details_129078831_spm_1001.2014.3001.5501]: https://blog.csdn.net/wenxingchen/article/details/129078831?spm=1001.2014.3001.5501