如何在FastAPI中禁用模式检查？

Question

我正在将一个服务从Flask迁移到FastAPI，并使用Pydantic模型来生成文档。但是，我对模式检查有点不确定。我担心会有一些意想不到的数据(如不同的字段格式)，它会返回一个错误。

在Pydantic文档中，有一些方法可以在不检查模式的情况下创建模型:https://Pydantic-docs . help manual . io/usage/models/# creating-models-without-validation

然而，由于这显然是由FastAPI自己实例化的，我不知道如何在从FastAPI返回时禁用这种模式检查。

Answer 1

FastAPI不强制执行任何类型的验证，所以如果您不想这样做，请不要使用Pydantic模型或类型提示。

app.get('/')
async def your_function(input_param):
  return { 'param': input_param }

# Don't use models or type hints when defining the function params.
# `input_param` can be anything, no validation will be performed.

但是，正如@Tryph正确指出的那样，由于您使用 Pydantic 来生成文档，因此您可以简单地使用 Any 类型，如下所示：

from typing import Any
from pydantic import BaseModel

class YourClass(BaseModel):
    any_value: Any

请注意，任何类型也接受无，因此实际上该字段是可选的。（另请参阅Pyd

Answer 2

您可以将请求模型设置为＜code＞类型。听写或键入。列表

from typing import Dict

app.post('/')
async def your_function(body: Dict):
  return { 'request_body': body}

Answer 3

您可以直接返回响应，或者使用自定义响应进行自动转换。在这种情况下，响应数据不会根据响应模型进行验证。但是您仍然可以在OpenAPI的附加响应中描述它。

例：

class SomeModel(BaseModel):
    num: int


@app.get("/get", response_model=SomeModel)
def handler(param: int):
    if param == 1:  # ok
        return {"num": "1"}
    elif param == 2:  # validation error
        return {"num": "not a number"}
    elif param == 3:  # ok (return without validation)
        return JSONResponse(content={"num": "not a number"})
    elif param == 4:  # ok (return without validation and conversion)
        return Response(content=json.dumps({"num": "not a number"}), media_type="application/json")