FastAPI FastApi 报错 “field required” 和 “value_error.missing” ，但参数是存在的

在本文中，我们将介绍 FastAPI 在处理请求时，可能会返回 “field required” 和 “value_error.missing” 错误的情况，尽管参数实际上是存在的。

问题描述

当我们使用 FastAPI 构建 Web 应用时，我们可能会定义一些路由函数，并在函数参数中声明所需的参数。例如，我们可能有一个接受 POST 请求的路由，需要一个名为 “username” 的参数。然而，即使在请求中提供了正确的参数，我们仍然可能会收到以下错误响应:

{
  "detail": [
    {
      "loc": [
        "body",
        "username"
      ],
      "msg": "field required",
      "type": "value_error.missing"
    }
  ]
}

这个错误消息表明，FastAPI 认为请求中缺少了必需的 “username” 参数。

可能的原因

造成这种情况的原因有几种。下面是一些可能引发该错误的情况：

1. 参数名称不匹配

在定义路由函数时，我们可能错误地将参数名声明为 “username”，但请求中实际提供的参数名称却不一样。这种情况下，FastAPI 会认为请求中缺少必需的参数。

from fastapi import FastAPI

app = FastAPI()

@app.post("/user")
async def create_user(username: str):
    return {"message": f"User created: {username}"}

在上面的示例中，我们定义了一个名为 “create_user” 的路由函数，它接受一个名为 “username” 的字符串参数。如果我们发送一个请求到 /user，但没有提供 “username” 参数或参数名称错误，FastAPI 将返回 “field required” 和 “value_error.missing” 错误。

2. 参数位置不正确

FastAPI 可能会进一步检查参数的位置。如果我们在路由函数中声明了一个参数，但将其放在了错误的位置，FastAPI 也会抛出 “field required” 和 “value_error.missing” 错误。

from fastapi import FastAPI

app = FastAPI()

@app.post("/user")
async def create_user(username: str, password: str):
    return {"message": f"User created: {username}"}

在上面的示例中，我们定义了一个名为 “create_user” 的路由函数，它接受两个名为 “username” 和 “password” 的字符串参数。如果我们发送一个请求到 /user，但将 “username” 和 “password” 参数位置颠倒，FastAPI 将返回相同的错误消息。

3. 请求的 body 数据不正确

如果我们在请求的 body 中发送了一个 JSON 数据，并且该数据的结构与路由函数参数的类型不匹配，FastAPI 也会给出类似的错误响应。在这种情况下，FastAPI 会认为请求中缺少了必要的参数。

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class User(BaseModel):
    username: str
    password: str

@app.post("/user")
async def create_user(user: User):
    return {"message": f"User created: {user.username}"}

在上面的示例中，我们定义了一个名为 “User” 的 Pydantic 模型，并在 “create_user” 路由函数的参数中使用了该模型。如果我们发送一个请求到 /user，但请求 body 中缺少了 “username” 或 “password” 字段，FastAPI 将返回类似的错误消息。

解决方法

为了解决 “field required” 和 “value_error.missing” 错误，我们可以逐一检查以下几个方面：

1. 确保参数名称一致

确保路由函数参数的名称与请求中提供的参数名称一致。如果名称不匹配，FastAPI 将认为参数缺失。

from fastapi import FastAPI

app = FastAPI()

@app.post("/user")
async def create_user(name: str):
    return {"message": f"User created: {name}"}

在上面的示例中，我们将参数名从 “username” 修改为了 “name”。如果我们发送一个请求到 /user，同时提供了 “name” 参数，FastAPI 将能够正常处理请求，并返回预期的响应。

2. 确保参数位置正确

确保在路由函数参数中声明参数的位置与请求中提供参数的位置一致。如果位置不正确，FastAPI 会认为参数缺失。

from fastapi import FastAPI

app = FastAPI()

@app.post("/user")
async def create_user(password: str, username: str):
    return {"message": f"User created: {username}"}

在上面的示例中，我们将参数位置进行了调换。如果我们发送一个请求到 /user，同时提供了 “username” 和 “password” 参数，FastAPI 将能够正常处理请求，并返回预期的响应。

3. 确保请求的 body 数据正确

当使用 Pydantic 模型接受请求的 body 数据时，确保请求中提供的数据与模型的结构相匹配。如果数据结构不匹配，FastAPI 将返回 “field required” 和 “value_error.missing” 错误。

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class User(BaseModel):
    username: str
    password: str

@app.post("/user")
async def create_user(user: User):
    return {"message": f"User created: {user.username}"}

在上面的示例中，我们定义了一个名为 “User” 的 Pydantic 模型，其中包含了 “username” 和 “password” 字段。如果我们发送一个请求到 /user，但请求 body 中缺少了 “username” 或 “password” 字段，FastAPI 将返回类似的错误消息。

总结

当 FastAPI 返回 “field required” 和 “value_error.missing” 错误时，我们需要仔细检查以下几个方面：参数名称是否一致，参数位置是否正确，以及请求的 body 数据是否与参数类型匹配。通过检查这些问题，并进行适当的调整，我们可以解决这些错误，并确保我们的 FastAPI 应用能够正常处理请求。