FastAPI: 如何在OpenAPI中获取自定义验证错误

在本文中，我们将介绍如何在FastAPI中获取自定义验证错误信息并在OpenAPI中进行展示。FastAPI是一个基于Python的现代、快速（高性能）、Web框架，它可以帮助我们构建高性能的API。

什么是FastAPI

FastAPI是一个易于使用、高性能的Web框架，它基于Python类型注解的强大功能进行操作。它提供了很多有用的特性，例如自动验证、数据转换和生成OpenAPI文档等。使用FastAPI，我们可以更加轻松地开发Web API，并且可以利用类型注解来编写更加健壮和可靠的代码。

自定义验证错误

在FastAPI中，我们通常使用Pydantic模型对请求体进行验证。当请求体与模型不匹配时，FastAPI会自动引发验证错误。但是，有时我们需要进行自定义的验证，并希望在出现错误时返回自定义的错误消息。

我们可以通过在模型中定义ValidationError异常以及自定义错误消息来实现自定义验证错误。下面的示例演示了如何在FastAPI中实现自定义验证错误。

from fastapi import FastAPI
from pydantic import BaseModel, ValidationError

app = FastAPI()

class Item(BaseModel):
    name: str
    price: float

@app.post("/items/")
async def create_item(item: Item):
    try:
        # 手动验证请求体
        item = Item(**item.dict())
    except ValidationError as e:
        # 自定义错误消息
        error_messages = []
        for error in e.errors():
            error_messages.append(f"Field '{error['loc'][0]}' {error['msg']}")
        return {"detail": error_messages}
    return {"item": item}

在上面的示例中，我们首先定义了一个Item模型，它包含了两个字段：name和price。然后，我们创建了一个create_item路由，它接受一个Item类型的参数。在路由处理程序中，我们手动验证了请求体，并在出现错误时返回自定义的错误消息。

在OpenAPI中展示自定义验证错误

FastAPI提供了自动生成OpenAPI文档的功能，它会自动将我们定义的数据模型转换为OpenAPI模式，并将其展示在生成的文档中。但是，默认情况下，FastAPI无法识别和展示我们自定义的验证错误消息。

为了在OpenAPI中展示自定义错误消息，我们可以使用fastapi.exceptions.RequestValidationError异常，并在exception_handlers装饰器中注册一个适当的处理函数。下面的示例演示了如何在FastAPI中展示自定义验证错误消息。

from fastapi import FastAPI, exceptions
from pydantic import BaseModel, ValidationError

app = FastAPI()

@app.exception_handler(exceptions.RequestValidationError)
async def validation_exception_handler(request, exc):
    error_messages = []
    for error in exc.errors():
        field_name = ".".join(error["loc"]) if len(error["loc"]) > 1 else error["loc"][0]
        error_messages.append({field_name: error["msg"]})
    return {"detail": error_messages}

class Item(BaseModel):
    name: str
    price: float

@app.post("/items/")
async def create_item(item: Item):
    try:
        # 手动验证请求体
        item = Item(**item.dict())
    except ValidationError as e:
        raise exceptions.RequestValidationError(e.errors())
    return {"item": item}

在上面的示例中，我们首先定义了一个异常处理函数validation_exception_handler，它会将RequestValidationError异常转换为自定义的错误消息。然后，在create_item路由处理程序中，我们使用raise关键字来引发RequestValidationError异常，并将自定义错误消息传递给它。

总结

本文介绍了如何在FastAPI中获取自定义验证错误并在OpenAPI中展示。我们可以通过定义自定义的验证逻辑和错误消息来实现自定义验证错误。通过使用fastapi.exceptions.RequestValidationError异常和exception_handlers装饰器，我们可以将自定义错误消息展示在生成的OpenAPI文档中。使用这些技巧，我们可以更好地管理和展示我们的API验证错误信息。通过FastAPI强大的功能，我们可以更加轻松地构建高性能的API。