python系列：FASTAPI 11-请求BODY的嵌套模型创建

已于 2024-06-03 19:40:15 修改
阅读量1.2k 收藏 13
点赞数 34
CC 4.0 BY-SA版权
分类专栏： # python 文章标签： python fastapi windows
于 2024-06-03 18:59:53 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/weixin_54626591/article/details/139422094
python 专栏收录该内容
330 篇文章 ¥99.90 ¥299.90
订阅专栏

FASTAPI 11-请求BODY的嵌套模型创建



FASTAPI 11-请求BODY的嵌套模型创建

前言

使用 FastAPI，你可以定义、校验、记录文档并使用任意深度嵌套的模型，使用Pydantic创建模型

一、声明属性子类型

将一个属性定义为拥有子元素的类型，首先，从Python的标准库 typing 模块中导入 List，使用方括号 [ 和 ] 将子类型作为「类型参数」传入，这完全是用于类型声明的标准 Python 语法。

from typing import Optional, List
from fastapi import Body, FastAPI, APIRouter
from pydantic import BaseModel<
了解本专栏 订阅专栏 解锁全文
【Python百日进阶-Web开发-FastAPI】Day809 - FastAPI的请求体 - 字段和嵌套模型
专注于医院数据分析技术与系统开发的创作与分享。
09-28 118
你可以使用 Pydantic 的 Field 为模型属性声明额外的校验和元数据。你还可以使用额外的关键字参数来传递额外的 JSON Schema 元数据。url: strname: str使用 FastAPI 你可以拥有 Pydantic 模型提供的极高灵活性，同时保持代码的简单、简短和优雅。编辑器支持（处处皆可自动补全！数据转换（也被称为解析/序列化）数据校验模式文档自动生成的文档。
fastapi参数-请求操作、参数、函数
u010428264的专栏
08-21 237
安装fastapi：pip install "fastapi[all]"运行命令：uvicorn main:app --reloadmainmain.pyappmain.py--reload运行后可查看api文档。
FASTAPI 11-请求BODY的嵌套模型创建
lzq599220的博客
03-19 691
使用 FastAPI，你可以定义、校验、记录文档并使用任意深度嵌套的模型，使用Pydantic创建模型定义一个出版社的模型， 将子模型用作Book模型的public属性的类型gt=0,"小说","杂志"],"tags":["python","java"],"public":{"public_name":"工业出版社","public_address":"中国"仅仅进行这样的声明，你将通过 FastAPI 获得：对被嵌入的模型也适用的编辑器支持（自动补全等）
FastAPI-嵌套模型
qq_41081716的博客
06-28 213
对象，FastAPI会处理数据的解析和验证。如果请求体中的数据不符合。将会自动根据传入的JSON请求体数据被实例化为。模型的定义，FastAPI将自动返回错误信息。
fastAPI(3)--嵌套模型、复杂数据类型
西卡卡的博客
04-08 842
1.嵌套模型 1).模型的属性可以是数据集合类型，比如list，dict,tuple,set等等。 class Item(BaseModel): name: str description: str = None price: float tax: float = None tags: list = [] from typing import List class Item(BaseModel): name: str descripti..
FastAPI学习-11. 请求body - 嵌套模型
qq_27371025的博客
09-13 544
前言 使用FastAPI，你可以定义、校验、记录文档并使用任意深度嵌套的模型(归功于Pydantic) List 字段 你可以将一个属性定义为拥有子元素的类型。例如 Pythonlist： from typing import Union from fastapi import FastAPI from pydantic import BaseModel app = FastAPI() ...
[Python FastApi] FastApi中Body的参数详解
在夜里，所有人都会失去年龄。
03-13 3026
fastapi 接口中只有一个参数时候，为遵循json传参规则，则会转换为传递一个字符串。若想保持一致，则在参数定义时候设置属性embed为True即可，默认为False。
python：Fastapi 请求体-嵌套模型
一名小测试
02-13 2391
请求体 - 字段 字段与使用Query、Path和Body在路径操作函数中声明额外的校验和元数据的方式相同，可以使用Pydantic的Field在Pydantic模型内部声明校验和元数据。 注意点：Field是直接从pydantic导入的，而不是像其他的（Query，Path，Body等）都从fastapi导入。 首先导入Field: frompydanticimportField 其次开始声明模型定义字段: frompydanticimport...
fastapi-crudrouter：动态的FastAPI路由器，可以自动为模型创建CRUD路由
01-30
:high_voltage: 以照明速度创建CRUD路线 :high_voltage: 动态的FastAPI路由器，可以为模型自动创建CRUD路由 说明文件： 源代码： 厌倦了重写相同的通用CRUD路由？ 是否需要为演示文稿或黑客马拉松快速制作原型功能？ 幸运的是， 您。 作为扩展到APIRouter包含 ，该FastAPI CRUDRouter会自动生成并为您记录您的CRUD路线，所有你需要做的是通过你的模型，也许你的数据库连接。 FastAPI-CRUDRouter的照明速度也很快，经过了严格的测试，并可以投入生产。 安装 pip install fastapi-crudrouter 基本用法 以下是CRUDRouter可以做什么的简单示例。 仅用十行代码，就可以生成任何模型所需的所有粗线。 您可以在找到生成的路由的完整列表。 from pydantic import BaseModel from fastapi import FastAPI from fastapi_crudrouter import MemoryCRUDRouter as CRUDRouter cl
Fastapi教程：使用Pydantic定义数据模型
merlon学习笔记
12-11 1450
Pydantic 是 FastAPI 的核心库，用于数据验证和序列化。通过基于 Python 类型注解的模型定义，Pydantic 可以自动验证请求数据的类型和格式，并提供详细的错误信息。它支持字段约束、嵌套模型、数据转换等功能，简化了数据处理流程。结合 FastAPI，Pydantic 帮助开发者高效构建高性能、类型安全的 API，确保数据一致性和代码的可维护性。
FastAPI-Body、Field
qq_41081716的博客
06-28 721
在FastAPI中，Body和Field是两个常用的注解，它们用于定义请求体中的数据或路径参数、查询参数等的处理方式。这两个注解都来自于Pydantic库，用于数据验证和解析，但它们的应用场景有所不同。
fastapi（七）Body
vanexph的博客
03-19 2607
我们已经提到过Path以及Query,下面来看看更好的对于请求正文的声明 body-多个参数 混合Path,Query和请求正文参数 eg: from fastapi import FastAPI, Path from pydantic import BaseModel app = FastAPI() class Item(BaseModel): name: str desc...
FastAPI--参数提交Request Body(3)
shykevin的博客
06-10 3772
一、概述 一般对于Request Body不会通过get提交，对于get提交的参数一般称为是查询参数。所以，如果是通过POTS,PUT等方式提交的参数信息，我们一般是放到Request Body来提交到我们的后端。 对于如何接收和校验请求体，FastApi提供的形式是使用：from pydantic import BaseModel 示例如下： import uvicorn ...
Python FastApi（7）：请求体
最新发布
游王子og的博客
03-27 894
Path。
FastAPI学习-7.POST请求body-多个参数
qq_27371025的博客
03-13 2830
前言 既然我们已经知道了如何使用 Path 和 Query，下面让我们来了解一下请求体声明的更高级用法。 混合使用 Path、Query 和请求体参数 你可以随意地混合使用 Path、Query 和请求体参数声明，FastAPI 会知道该如何处理。 还可以通过将默认值设置为 None 来将请求体参数声明为可选参数： from typing import Optional from fastapi import FastAPI, Path from pydantic import BaseModel ap
fastAPI(2)--请求参数、路径参数、多body
西卡卡的博客
04-08 1375
1.请求参数附加信息 #!/usr/bin/env python # encoding: utf-8 from fastapi import FastAPI, Query from typing import Optional import uvicorn app = FastAPI() @app.get('/items/') async def read_items(q: Optional[str] = Query(None, min_length=3, max_length=50)):
FastAPI 教程翻译 - 用户指南 8 - 请求主体 - 多个参数
人生苦短，我用Python！
05-27 501
FastAPI 教程翻译 - 用户指南 8 - 请求主体 - 多个参数 FastAPI Tutorial - User Guide - Body - Multiple Parameters Now that we have seen how to use Path and Query, let’s see more advanced uses of request body declarations. 既然我们已经了解了如何使用 Path 和 Query，那么让我们来看一下请求主体声明的更高级用法。 Mix
FastAPI 教程翻译 - 用户指南 9 - 请求主体 - 字段
人生苦短，我用Python！
05-27 505
FastAPI 教程翻译 - 用户指南 9 - 请求主体 - 字段 FastAPI Tutorial - User Guide - Body - Fields The same way you can declare additional validation and metadata in path operation function parameters with Query, Path and Body, you can declare validation and metadata inside
FastAPI获取Body
oscarli的博客
10-31 1339
FastAPI获取Body
python fastapi 获取请求参数
03-20
<think>好的，我现在要回答用户关于如何在FastAPI中获取请求参数的问题。首先，我需要回忆一下FastAPI的基本用法，特别是处理请求参数的几种方式。记得FastAPI支持路径参数、查询参数、请求体参数等，还有可能涉及表单数据和文件上传。 首先，路径参数。用户可能在URL路径中定义参数，例如/user/{id}，这时候在FastAPI中可以通过在路径操作函数的参数中声明来获取。比如定义一个函数def get_user(id: int)，这样id就会自动从URL路径中提取并转换为整数类型。需要确认是否正确处理了类型转换和验证，比如如果用户传入非整数字符串，FastAPI会自动返回错误响应。 然后是查询参数，也就是URL中的问号后面的参数，比如/item?skip=0&limit=10。在FastAPI中，这些参数会被视为函数参数的默认值，例如def read_item(skip: int = 0, limit: int = 10)。如果用户没有提供这些参数，就会使用默认值。这里需要注意可选参数和必填参数的处理，以及参数类型的校验。 接下来是请求体参数，通常用于POST、PUT等请求，发送JSON数据。在FastAPI中需要用到Pydantic模型来定义数据结构。比如定义一个类Item(BaseModel)，然后在路径操作函数中声明参数item: Item，这样FastAPI会自动解析请求体中的JSON数据到Item实例。需要说明如何创建Pydantic模型，并处理嵌套结构或复杂类型。 还有表单数据和文件上传的情况。这时候需要使用Form和File来声明参数，同时需要安装python-multipart库。比如处理表单字段username和password，可以使用def login(username: str = Form(...), password: str = Form(...))。文件上传则用File，比如file: UploadFile = File(...)。需要提醒用户安装必要的依赖，并注意处理文件内容。 此外，可能还需要提到请求头参数和cookie参数的获取方式，虽然用户的问题可能主要关注常见的几种参数类型。但为了全面性，可以简要说明如何使用Header和Cookie来获取这些参数。 还需要考虑错误处理，例如参数缺失或类型错误时，FastAPI会自动生成相应的错误响应。比如路径参数类型不匹配会返回422状态码，并给出具体的错误信息。这对于开发调试很有帮助。 最后，可能需要给出一个完整的示例，综合几种参数类型，展示如何在一个路径操作函数中同时使用路径参数、查询参数和请求体参数。例如，一个更新用户信息的接口，接收用户ID作为路径参数，分页参数作为查询参数，用户数据作为请求体。这样用户可以看到不同参数类型的使用方式。 另外，参考用户提供的引用内容中，提到了SQLAlchemy的配置和Django处理外部API请求的例子。虽然FastAPI和Django有所不同，但可以借鉴如何将请求参数与数据库操作结合，比如使用获取的参数查询数据库，或者将参数传递给外部API。不过用户的问题主要是关于获取参数，这部分可能暂时不需要深入数据库操作，但可以提到参数如何用于后续处理，比如存储到数据库或调用其他服务。 总结一下，回答的结构应该是先介绍不同类型的参数，然后分别详细说明每种参数的获取方法，包括代码示例，最后可能综合示例和注意事项。需要确保代码示例符合FastAPI的最新实践，语法正确，并且使用中文解释清楚每个步骤。同时，需要检查是否有遗漏的参数类型，或者是否有常见的错误需要提醒用户注意，比如忘记安装python-multipart导致表单处理失败。</think>### 如何在FastAPI中获取请求参数？ 在FastAPI中，获取请求参数主要通过以下几种方式实现，具体方法如下： --- #### 1. **路径参数（Path Parameters）** 路径参数直接嵌入在URL路径中，用于标识资源。例如，获取用户ID为`123`的信息： ```python from fastapi import FastAPI app = FastAPI() @app.get("/users/{user_id}") async def get_user(user_id: int): return {"user_id": user_id} ``` - **说明**：`user_id`会从URL路径中提取并自动转换为整数类型。如果传入非整数（如`abc`），FastAPI会返回类型错误[^1]。 --- #### 2. **查询参数（Query Parameters）** 查询参数是URL中`?`后的键值对，例如`/items?skip=0&limit=10`： ```python @app.get("/items/") async def read_items(skip: int = 0, limit: int = 10): return {"skip": skip, "limit": limit} ``` - **说明**：`skip`和`limit`是可选参数，未提供时使用默认值。若需必填参数，可移除默认值。 --- #### 3. **请求体参数（Body Parameters）** 用于接收JSON格式的请求体数据，需结合Pydantic模型： ```python from pydantic import BaseModel class Item(BaseModel): name: str price: float @app.post("/items/") async def create_item(item: Item): return item ``` - **说明**：FastAPI会自动将请求体JSON解析为`Item`对象，支持嵌套模型和复杂类型验证[^1]。 --- #### 4. **表单数据（Form Data）** 处理HTML表单提交的数据（如`application/x-www-form-urlencoded`）： ```python from fastapi import Form @app.post("/login/") async def login(username: str = Form(...), password: str = Form(...)): return {"username": username} ``` - **注意**：需安装`python-multipart`库，否则会报错。 --- #### 5. **文件上传（File Uploads）** 接收上传的文件： ```python from fastapi import UploadFile, File @app.post("/upload/") async def upload_file(file: UploadFile = File(...)): return {"filename": file.filename} ``` - **说明**：`UploadFile`提供异步文件流操作，适用于大文件上传。 --- #### 6. **请求头参数（Header Parameters）** 从HTTP头部提取参数： ```python from fastapi import Header @app.get("/headers/") async def read_header(user_agent: str | None = Header(default=None)): return {"User-Agent": user_agent} ``` --- #### 7. **Cookie参数（Cookie Parameters）** 获取Cookie中的值： ```python from fastapi import Cookie @app.get("/cookies/") async def read_cookie(session_id: str | None = Cookie(default=None)): return {"session_id": session_id} ``` --- ### 完整示例：综合使用多种参数 ```python @app.put("/users/{user_id}") async def update_user( user_id: int, # 路径参数 item: Item, # 请求体参数 q: str | None = None, # 查询参数 token: str = Header(...) # 请求头参数 ): return {"user_id": user_id, "item": item, "q": q, "token": token} ``` --- ### 注意事项 - **类型校验**：FastAPI会自动校验参数类型，若类型不匹配会返回`422 Unprocessable Entity`错误。 - **依赖安装**：处理表单或文件时需安装`python-multipart`。 - **异步支持**：所有操作支持异步（`async`），适合高并发场景[^3]。 ---
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

坦笑&&life

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值