fastapi(十三)-错误处理

在许多情况下你的api都需要向用户告知错误信息，
like：
1、客户端没有操作权限
2、不能访问资源
3、资源不存在等
当向客户端响应错误信息的时候可以使用HTTPException
HTTPException
eg:

from fastapi import FastAPI, HTTPException

app = FastAPI()

items = {
     "foo": "The Foo Wrestlers"}


@app.get("/items/{item_id}")
async def read_item(item_id: str):
    if item_id not in items:
        raise HTTPException(status_code=404, detail="Item not found")
    return {
     "item": items[item_id]}

httpexception 是一个正常的python exception只是添加了一些api的数据。
所以你只能使用raise来抛出错误。
一旦触发将立即暂停执行操作，并发送error给客户端
在detail中可以传入任意可转换为json格式的值，
添加自定义headers
在一些情况下对http error添加自定义的头部信息将会很有用，比如一些安全类型。

@app.get("/items-header/{item_id}")
async def read_item_header(item_id: str):
    if item_id not in items:
        raise HTTPException(
            status_code=404,
            detail="Item not found",
            headers={
     "X-Error": "There goes my error"},
        )
    return {
     "item": items[item_id]}

安装自定义异常处理
你可以添加自定义异常处理通过@app.exception_handler():
eg:

from fastapi import FastAPI, Request
from fastapi.responses import JSONResponse


class UnicornException(Exception):
    def __init__(self, name: str):
        self.name = name


app = FastAPI()


@app.exception_handler(UnicornException)
async def unicorn_exception_handler(request: Request, exc: UnicornException):
    return JSONResponse(
        status_code=418,
        content={
     "message": f"Oops! {exc.name} did something. There goes a rainbow..."},
    )


@app.get("/unicorns/{name}")
async def read_unicorn(name: str):
    if name == "yolo":
        raise UnicornException(name=name)
    return {
     "unicorn_name": name}

重写默认异常处理
fastapi有一些默认异常处理。
这些处理器将会在raise HttpException或请求中有不可用的值的时候返回默认的json响应。
重写请求验证异常
当请求中包含不可用的数据时，fastapi将会raise RequestValidationError。
为了重写它，需要导入它并且在@app.exception_handler(RequestValidationError)中去装饰新的处理程序。
eg:

from fastapi import FastAPI, HTTPException
from fastapi.exceptions import RequestValidationError
from fastapi.responses import PlainTextResponse
from starlette.exceptions import HTTPException as StarletteHTTPException

app = FastAPI()


@app.exception_handler(StarletteHTTPException)
async def http_exception_handler(request, exc):
    return PlainTextResponse(str(exc.detail), status_code=exc.status_code)


@app.exception_handler(RequestValidationError)
async def validation_exception_handler(request, exc):
    return PlainTextResponse(str(exc), status_code=400)


@app.get("/items/{item_id}")
async def read_item(item_id: int):
    if item_id == 3:
        raise HTTPException(status_code=418, detail="Nope! I don't like 3.")
    return {
     "item_id": item_id}

RequestValidationError 中的body将会接收不可用的data。
你可以使用它，将它纪录到日志系统中一边查找错误。
eg:

from fastapi import FastAPI, Request, status
from fastapi.encoders import jsonable_encoder
from fastapi.exceptions import RequestValidationError
from fastapi.responses import JSONResponse
from pydantic import BaseModel

app = FastAPI()


@app.exception_handler(RequestValidationError)
async def validation_exception_handler(request: Request, exc: RequestValidationError):
    return JSONResponse(
        status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
        content=jsonable_encoder({
     "detail": exc.errors(), "body": exc.body}),
    )


class Item(BaseModel):
    title: str
    size: int


@app.post("/items/")
async def create_item(item: Item):
    return item

RequestValidationError vs ValidationError
RequestValidationError 是ValidationError的子类。
重写HTTPException

from fastapi import FastAPI, HTTPException
from fastapi.exceptions import RequestValidationError
from fastapi.responses import PlainTextResponse
from starlette.exceptions import HTTPException as StarletteHTTPException

app = FastAPI()


@app.exception_handler(StarletteHTTPException)
async def http_exception_handler(request, exc):
    return PlainTextResponse(str(exc.detail), status_code=exc.status_code)


@app.exception_handler(RequestValidationError)
async def validation_exception_handler(request, exc):
    return PlainTextResponse(str(exc), status_code=400)


@app.get("/items/{item_id}")
async def read_item(item_id: int):
    if item_id == 3:
        raise HTTPException(status_code=418, detail="Nope! I don't like 3.")
    return {
     "item_id": item_id}

注意：fastapis HTTPException 继承自Starlette's HTTPException。fastapis HTTPException只是允许你添加一些头部到返回响应中，但是当注册异常处理器的时候建议使用Starlette’s HTTPException