FastAPI 使用关键字字段名

在本文中，我们将介绍如何在FastAPI中使用关键字字段名。

FastAPI是一个基于Python的现代化（快速，易用，标准）Web框架，它使用了最新的Python异步特性。而Pydantic是FastAPI的基础之一，它是一个数据验证和解析的库，它通过将Python类型转换为有效数据模型，可以快速简便地验证、解析数据。

在使用FastAPI和Pydantic处理请求和响应时，有时我们可能会遇到需要使用关键字字段名的情况。关键字字段名是指在数据模型的字段名上使用Python关键字。但是，由于关键字是Python的保留字，因此不能直接在字段名中使用。下面是一些示例，来说明如何使用关键字字段名。

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()


class KeywordModel(BaseModel):
    from: str
    def: str
    class_: str


@app.post("/keyword")
async def create_item(item: KeywordModel):
    return {"item": item}


@app.get("/keyword/{from_location}/{def_name}/{class_name}")
async def get_item(from_location: str, def_name: str, class_name: str):
    return {"from_location": from_location, "def_name": def_name, "class_name": class_name}

在上面的代码中，我们定义了一个数据模型KeywordModel，其中包含了三个使用了关键字字段名的字段。在这个例子中，我们使用了from、def、class_三个关键字作为字段名。要注意的是，因为关键字是保留字，我们在字段名后面添加了下划线，以避免与Python的关键字冲突。

然后，我们定义了两个路由/keyword和/keyword/{from_location}/{def_name}/{class_name}，分别用于接收POST请求和GET请求。在POST请求中，我们使用了关键字字段名的数据模型KeywordModel来验证和解析请求的数据。在GET请求中，我们通过URL路径参数来获取关键字字段名。

通过上面的示例，我们可以看到，使用关键字字段名并不会对FastAPI和Pydantic的使用造成任何问题。关键是在字段名后面添加下划线以避免冲突。

阅读更多：FastAPI 教程