You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们

如何修改FastAPI/Pydantic的json输出字段名称?

可以通过使用 Pydantic 的 Field 类来指定字段的别名(alias),从而修改 json 输出的字段名称。例如:

from fastapi import FastAPI
from pydantic import BaseModel, Field

app = FastAPI()

class ItemOut(BaseModel):
    name: str
    description: str
    price: float
    tax: float = Field(..., alias="sales_tax")

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

在上面的示例中,ItemOuttax 字段通过 Field 类的 alias 参数指定了别名 sales_tax,因此在输出 json 中该字段的名称将为 sales_tax 而不是 tax

另外,还可以使用 Pydantic 的 schema_extra 参数来指定整个模型的别名,例如:

class ItemOut(BaseModel):
    name: str
    description: str
    price: float
    tax: float

    class Config:
        schema_extra = {
            "example": {
                "name": "Foo",
                "description": "Bar",
                "price": 10.0,
                "sales_tax": 1.5
            }
        }

在上面的示例中,通过在 Config 中使用 schema_extra 参数,并给出包含别名的示例 json 数据,可以让 FastAPI 自动生成正确的 API 文档,并在文档中使用别名。

本文内容通过AI工具匹配关键字智能整合而成,仅供参考,火山引擎不对内容的真实、准确或完整作任何形式的承诺。如有任何问题或意见,您可以通过联系service@volcengine.com进行反馈,火山引擎收到您的反馈后将及时答复和处理。
展开更多
面向开发者的云福利中心,ECS 60元/年,域名1元起,助力开发者快速在云上构建可靠应用

社区干货

漫谈开源许可证:开发者需要知道的法理和事例

[picture.image](https://p6-volc-community-sign.byteimg.com/tos-cn-i-tlddhu82om/bdf0c3a6caf14a78916519788bee5a22~tplv-tlddhu82om-image.image?=&rk3s=8031ce6d&x-expires=1714839638&x-signature=bJQe1QMO99XHyAG%2Bga%2Bc06yPERk%3D)来源|字节跳动 Web Infra - Web Solutions 团队 感谢字节跳动开源法务 @孙振华 提供的专业指导和修改意见。 本文仅供开发者探讨,不构成任何法律意见。如有需求请咨询公...

特惠活动

热门爆款云服务器

100%性能独享,更高内存性能更佳,学习测试、web前端、企业应用首选,每日花费低至0.55元
60.00/1212.00/年
立即购买

域名注册服务

cn/top/com等热门域名,首年低至1元,邮箱建站必选
1.00/首年起32.00/首年起
立即购买

DCDN国内流量包100G

同时抵扣CDN与DCDN两种流量消耗,加速分发更实惠
2.00/20.00/年
立即购买

如何修改FastAPI/Pydantic的json输出字段名称? -优选内容

漫谈开源许可证:开发者需要知道的法理和事例
[picture.image](https://p6-volc-community-sign.byteimg.com/tos-cn-i-tlddhu82om/bdf0c3a6caf14a78916519788bee5a22~tplv-tlddhu82om-image.image?=&rk3s=8031ce6d&x-expires=1714839638&x-signature=bJQe1QMO99XHyAG%2Bga%2Bc06yPERk%3D)来源|字节跳动 Web Infra - Web Solutions 团队 感谢字节跳动开源法务 @孙振华 提供的专业指导和修改意见。 本文仅供开发者探讨,不构成任何法律意见。如有需求请咨询公...

如何修改FastAPI/Pydantic的json输出字段名称? -相关内容

特惠活动

热门爆款云服务器

100%性能独享,更高内存性能更佳,学习测试、web前端、企业应用首选,每日花费低至0.55元
60.00/1212.00/年
立即购买

域名注册服务

cn/top/com等热门域名,首年低至1元,邮箱建站必选
1.00/首年起32.00/首年起
立即购买

DCDN国内流量包100G

同时抵扣CDN与DCDN两种流量消耗,加速分发更实惠
2.00/20.00/年
立即购买

产品体验

体验中心

云服务器特惠

云服务器
云服务器ECS新人特惠
立即抢购

白皮书

一图详解大模型
浓缩大模型架构,厘清生产和应用链路关系
立即获取

最新活动

爆款1核2G共享型服务器

首年60元,每月仅需5元,限量秒杀
立即抢购

火山引擎增长体验专区

丰富能力激励企业快速增长
查看详情

数据智能VeDI

易用的高性能大数据产品家族
了解详情

一键开启云上增长新空间

立即咨询