mirror of
https://github.com/fastapi-practices/fastapi_best_architecture.git
synced 2025-08-18 23:11:48 +08:00
e1edcade21
* WIP: add rbac authorization * Perform pre-commit fixes * add rbac route whitelist * add init test data user role associations * Restore database table id naming to fix generic crud base * Add database section value uniqueness settings * Update the test directory to tests * Update route_name file name to health_check * Split user auth and user action interfaces * Fix conflict between merge and current branch * Add pymysql dependencies * Fix RBAC authentication method * Add the select serialisation tool * Fix missing return messages due to global exception handler slicing * Update the user interface with associated relationships * Add items to be completed * Perform pre-commit fixes * Add pre-made routers * Paging data return structure optimisation * Split user auth and user interface tests * Fix user register test data structure error * Fix duplicate named test classes
115 lines
3.9 KiB
Python
115 lines
3.9 KiB
Python
#!/usr/bin/env python3
|
|
# -*- coding: utf-8 -*-
|
|
import json
|
|
|
|
from fastapi import FastAPI, Request
|
|
from fastapi.exceptions import RequestValidationError, HTTPException
|
|
from pydantic import ValidationError
|
|
from starlette.responses import JSONResponse
|
|
from uvicorn.protocols.http.h11_impl import STATUS_PHRASES
|
|
|
|
from backend.app.common.exception.errors import BaseExceptionMixin
|
|
from backend.app.common.response.response_schema import response_base
|
|
from backend.app.core.conf import settings
|
|
|
|
|
|
def _get_exception_code(status_code):
|
|
"""
|
|
获取返回状态码, OpenAPI, Uvicorn... 可用状态码基于 RFC 定义, 详细代码见下方链接
|
|
|
|
`python 状态码标准支持 <https://github.com/python/cpython/blob/6e3cc72afeaee2532b4327776501eb8234ac787b/Lib/http
|
|
/__init__.py#L7>`__
|
|
|
|
`IANA 状态码注册表 <https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml>`__
|
|
|
|
:param status_code:
|
|
:return:
|
|
"""
|
|
try:
|
|
STATUS_PHRASES[status_code]
|
|
except Exception:
|
|
code = 400
|
|
else:
|
|
code = status_code
|
|
return code
|
|
|
|
|
|
def register_exception(app: FastAPI):
|
|
@app.exception_handler(HTTPException)
|
|
def http_exception_handler(request: Request, exc: HTTPException):
|
|
"""
|
|
全局HTTP异常处理
|
|
|
|
:param request:
|
|
:param exc:
|
|
:return:
|
|
"""
|
|
return JSONResponse(
|
|
status_code=_get_exception_code(exc.status_code),
|
|
content=response_base.fail(code=exc.status_code, msg=exc.detail),
|
|
headers=exc.headers,
|
|
)
|
|
|
|
@app.exception_handler(RequestValidationError)
|
|
def validation_exception_handler(request: Request, exc: RequestValidationError):
|
|
"""
|
|
数据验证异常处理
|
|
|
|
:param request:
|
|
:param exc:
|
|
:return:
|
|
"""
|
|
message = ''
|
|
data = {}
|
|
for raw_error in exc.raw_errors:
|
|
if isinstance(raw_error.exc, ValidationError):
|
|
exc = raw_error.exc
|
|
if hasattr(exc, 'model'):
|
|
fields = exc.model.__dict__.get('__fields__')
|
|
for field_key in fields.keys():
|
|
field_title = fields.get(field_key).field_info.title
|
|
data[field_key] = field_title if field_title else field_key
|
|
errors_len = len(exc.errors())
|
|
for error in exc.errors():
|
|
field = str(error.get('loc')[-1])
|
|
_msg = error.get('msg')
|
|
errors_len = errors_len - 1
|
|
message += (
|
|
f'{data.get(field, field)} {_msg}' + ', '
|
|
if errors_len > 0
|
|
else f'{data.get(field, field)} {_msg}' + '.'
|
|
)
|
|
elif isinstance(raw_error.exc, json.JSONDecodeError):
|
|
message += 'json解析失败'
|
|
return JSONResponse(
|
|
status_code=422,
|
|
content=response_base.fail(
|
|
code=422,
|
|
msg='请求参数非法' if len(message) == 0 else f'请求参数非法: {message}',
|
|
data={'errors': exc.errors()} if message == '' and settings.UVICORN_RELOAD is True else None,
|
|
),
|
|
)
|
|
|
|
@app.exception_handler(Exception)
|
|
def all_exception_handler(request: Request, exc: Exception):
|
|
"""
|
|
全局异常处理
|
|
|
|
:param request:
|
|
:param exc:
|
|
:return:
|
|
"""
|
|
if isinstance(exc, BaseExceptionMixin):
|
|
return JSONResponse(
|
|
status_code=_get_exception_code(exc.code),
|
|
content=response_base.fail(code=exc.code, msg=str(exc.msg), data=exc.data if exc.data else None),
|
|
)
|
|
|
|
else:
|
|
return JSONResponse(
|
|
status_code=500,
|
|
content=response_base.fail(code=500, msg=str(exc))
|
|
if settings.UVICORN_RELOAD
|
|
else response_base.fail(code=500, msg='Internal Server Error'),
|
|
)
|