FastAPI -- 第一弹(查询参数/路径参数/请求体参数)

已于 2024-07-15 08:40:48 修改
阅读量342 收藏 10
点赞数 5
分类专栏： Python FastAPI 文章标签： fastapi Python python ORM
于 2024-07-11 17:29:44 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/f704084109/article/details/140313168
版权

Hello World

经典的 Hello World

安装

pip install fastapi
pip install "uvicorn[standard]"

main.py

from typing import Union

from fastapi import FastAPI

app = FastAPI()


@app.get("/")
def read_root():
    return {"Hello": "World"}


@app.get("/items/{item_id}")
def read_item(item_id: int, q: Union[str, None] = None):
    return {"item_id": item_id, "q": q}

运行

uvicorn main:app --reload

交互式 API 文档

http://127.0.0.1:8000/docs（由 Swagger UI生成）
或者
http://127.0.0.1:8000/redoc （由 ReDoc 生成）

参数

路径参数

from fastapi import FastAPI

app = FastAPI()

# http://127.0.0.1:8000/items/foo
@app.get("/items/{item_id}")
async def read_item(item_id):

	# return {"item_id": "foo"}
    return {"item_id": item_id}
声明路径参数的类型
from fastapi import FastAPI

app = FastAPI()


@app.get("/items/{item_id}")
async def read_item(item_id: int):	#  通过类型注解，声明 item_id 为 int 类型
    return {"item_id": item_id}
数据转换
from fastapi import FastAPI

app = FastAPI()


@app.get("/items/{item_id}")
async def read_item(item_id: int):	#  通过类型注解，声明 item_id 为 int 类型
    return {"item_id": item_id}

运行上面的示例代码，并访问 http://127.0.0.1:8000/items/3，
返回的响应如下：
{"item_id": 3}

顺序很重要

url /users/me 和 /users/{user_id} , 路径操作是按顺序依次运行的，因此，一定要在/users/{user_id}之前声明 /users/me ：

from fastapi import FastAPI

app = FastAPI()


@app.get("/users/me")
async def read_user_me():
    return {"user_id": "the current user"}


@app.get("/users/{user_id}")
async def read_user(user_id: str):
    return {"user_id": user_id}

否则，/users/{user_id} 将匹配 /users/me，FastAPI 会认为正在接收值为 “me” 的 user_id 参数

查询参数（问号参数）

声明的参数不是路径参数时，路径操作函数会把该参数自动解释为查询参数。
参数优先级： 路径参数> 查询参数

默认值 | 可选参数，必填参数
from fastapi import FastAPI

app = FastAPI()

fake_items_db = [{"item_name": "Foo"}, {"item_name": "Bar"}, {"item_name": "Baz"}]

# skip: int = 0, limit: int = 10
# skip 和 limit 都设置了默认值
# 
# 访问 http://127.0.0.1:8000/items/
# 访问 http://127.0.0.1:8000/items/?skip=0&limit=10
# 访问 http://127.0.0.1:8000/items/?skip=20
# 上面的三种访问方式是等效的，
# 所以设置默认值之后的参数等效于可选参数
#
# 同理 将其他类型的字段设置为其对应的**默认值**或者**None**，就可以使该字段变为 **可选字段**
# 例如： int = 0， str = "",  bool = False
#       int|None = None ， str|None = None,  bool|None = None
# 建议使用 
@app.get("/items/")
async def read_item(skip: int = 0, limit: int = 10):
    return fake_items_db[skip : skip + limit]

必选参数

不设置默认值的参数，就是必选参数

使用 Query 作为默认值
from typing import Union

from fastapi import FastAPI, Query

app = FastAPI()


@app.get("/items/")
async def read_items(q: Union[str, None] = Query(default=None, max_length=50)):
    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
    if q:
        results.update({"q": q})
    return results
使用 Query 添加更多校验
from typing import Union

from fastapi import FastAPI, Query

app = FastAPI()


@app.get("/items/")
async def read_items(
    q: Union[str, None] = Query(
        default=None, 
        min_length=3, 
        max_length=50,
        alias="An alternative name for the parameter field.",
        title="Human-readable title",
        description="Human-readable description",
        deprecated="Mark this parameter field as deprecated.",
        pattern="RegEx pattern for strings.",
        ),
):
    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
    if q:
        results.update({"q": q})
    return results

请求体

创建数据模型&声明请求体
from fastapi import FastAPI
from pydantic import BaseModel

# 创建数据模型
class Item(BaseModel):
    name: str
    description: str | None = None
    price: float
    tax: float | None = None


app = FastAPI()


@app.post("/items/")
async def create_item(item: Item):	
# item: Item, 声明 item Item 类型，
# 由于 Item 属于 BaseModel类型，所以会被识别为请求体 
    return item
参数识别规则

函数参数按如下规则进行识别：

  • 路径中声明了相同参数的参数，是路径参数
  • 类型是（int、float、str、bool 等）单类型的参数，是查询参数
  • 类型是 Pydantic 模型的参数，是请求体
校验请求体字段
from typing import Annotated

from fastapi import Body, FastAPI
from pydantic import BaseModel, Field

app = FastAPI()


class Item(BaseModel):
    name: str

	# 通过 Field 为字段 description 增加更多信息 或者校验
	# TODO： 
	# 		from pydantic import Field
	# 		from fastapiimport Query，Path，Body
    description: str | None = Field(
        default=None, title="The description of the item", max_length=300
    )
    price: float = Field(gt=0, description="The price must be greater than zero")
    tax: float | None = None


@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Annotated[Item, Body(embed=True)]):
    results = {"item_id": item_id, "item": item}
    return results
多个请求体参数&请求体中的单一值
from typing import Annotated

from fastapi import Body, FastAPI
from pydantic import BaseModel

app = FastAPI()


class Item(BaseModel):
    name: str
    description: str | None = None
    price: float
    tax: float | None = None


class User(BaseModel):
    username: str
    full_name: str | None = None


@app.put("/items/{item_id}")
async def update_item(
	# 多个请求体参数
    item_id: int, item: Item, 
    user: User, 
    
    # 通过 Annotated[int, Body()] 将 声明为请求体参数，
    # 否则根据参数识别规则，将被识别为 查询参数
    importance: Annotated[int, Body()] 
):
    results = {"item_id": item_id, "item": item, "user": user, "importance": importance}
    return results

期望请求体示例

{
    "item": {
        "name": "Foo",
        "description": "The pretender",
        "price": 42.0,
        "tax": 3.2
    },
    "user": {
        "username": "dave",
        "full_name": "Dave Grohl"
    },
    "importance": 5
}

模型

嵌入单个请求体

from typing import Annotated

from fastapi import Body, FastAPI
from pydantic import BaseModel

app = FastAPI()


class Item(BaseModel):
    name: str
    description: str | None = None
    price: float
    tax: float | None = None


@app.put("/items/{item_id}")
async def update_item(item_id: int, 
                      
                      # 通过 Annotated[Item, Body(embed=True)]
                      # 将 item 作为 key 嵌入到请求体中
                      item: Annotated[Item, Body(embed=True)],
                      ):
    results = {"item_id": item_id, "item": item}
    return results

期望请求体示例

{
    "item": {
        "name": "Foo",
        "description": "The pretender",
        "price": 42.0,
        "tax": 3.2
    }
}

嵌套模型 & List

from typing import List, Union

from fastapi import FastAPI
from pydantic import BaseModel, HttpUrl

app = FastAPI()


class Image(BaseModel):
    url: HttpUrl
    name: str


class Item(BaseModel):
    name: str
    description: str | None = None
    price: float
    tax: float | None = None
    tags: set[str] = set()
	
	# 通过 list 将 Image 作为 元素嵌入到 Item中
    images: list[Image] | None = None
    
	# 同理，通过 list 将 str作为 元素嵌入到 Item 中
    # images: List[str] | None = None
    # images: List[int] | None = None
    
	# 同理，将 Image 直接 嵌入到 Item 中
    # images: Image | None = None



@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Item):
    results = {"item_id": item_id, "item": item}
    return results

期望请求体示例

{
    "name": "Foo",
    "description": "The pretender",
    "price": 42.0,
    "tax": 3.2,
    "tags": [
        "rock",
        "metal",
        "bar"
    ],
    "images": [
        {
            "url": "http://example.com/baz.jpg",
            "name": "The Foo live"
        },
        {
            "url": "http://example.com/dave.jpg",
            "name": "The Baz"
        }
    ]
}

多层嵌套模型

from fastapi import FastAPI
from pydantic import BaseModel, HttpUrl

app = FastAPI()


class Image(BaseModel):
    url: HttpUrl
    name: str


class Item(BaseModel):
    name: str
    description: str | None = None
    price: float
    tax: float | None = None
    tags: set[str] = set()
    images: list[Image] | None = None


class Offer(BaseModel):
    name: str
    description: str | None = None
    price: float
    items: list[Item]


@app.post("/offers/")
async def create_offer(offer: Offer):

    return from fastapi import FastAPI
from pydantic import BaseModel, HttpUrl

app = FastAPI()


class Image(BaseModel):
    url: HttpUrl
    name: str


class Item(BaseModel):
    name: str
    description: str | None = None
    price: float
    tax: float | None = None
    tags: set[str] = set()
    images: list[Image] | None = None


class Offer(BaseModel):
    name: str
    description: str | None = None
    price: float
    items: list[Item]


@app.post("/offers/")
async def create_offer(offer: Offer):
	# 多层嵌套
	# offer -> Item         -> Image
	#       -> list[Item]
	#                       -> list[Image]
    return offer

为模型添加额外信息

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()


class Item(BaseModel):
    name: str
    description: str | None = None
    price: float
    tax: float | None = None

    model_config = {
        "json_schema_extra": {
            "examples": [
                {
                    "name": "Foo",
                    "description": "A very nice Item",
                    "price": 35.4,
                    "tax": 3.2,
                }
            ]
        }
    }


@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Item):
    results = {"item_id": item_id, "item": item}
    return results

到此结  DragonFangQy 2024.07.11

DragonFangQy
关注
专栏目录
纯Python编写的Dash-FastAPI-Admin中后台管理系统源码
03-25
项目概述：这是一款纯Python实现的后台管理系统——Dash-FastAPI-Admin，整合了Dash和FastAPI框架，旨在为用户提供高效、便捷的中后台管理解决方案。项目主要采用Python语言编写，同时包含了JavaScript和CSS以支持...
fastapi-jsonrpc:基于fastapi的JSON-RPC服务器
05-25
描述 基于fastapi的JSON-RPC服务器： 动机 自动生成的JSON-RPC的OpenAPI和Swagger （感谢fastapi）！... Entrypoint ( '/api/v1/jsonrpc' ) class MyError ( jsonrpc . BaseError ): CODE = 5000 M
fastapi-admin:基于FastAPI和Tortoise ORM的FastAPI管理员仪表板
03-20
FastAPI管理介绍FastAPI-Admin是基于和的管理仪表板。 FastAPI-Admin仅需几个配置即可提供即用的即用功能。现场演示在查看现场演示。用户名： admin密码： 123456数据库中的数据将每天恢复。屏幕截图要求框架作为您...
fastapi-celery-example
03-09
将芹菜与FastAPI结合使用该存储库使用FastAPI实现的第二个示例。快速开始使用docker-compose运行只需一行命令docker-compose up -d即可启动redis，Fastapi服务器，flower和我们的worker。 然后只需转到尝试我们的...
fastapi-mqtt:fastapi-mqtt是MQTT协议的扩展
04-04
fastapi-mqtt MQTT是一种轻量级的发布/订阅消息传递协议，设计用于低带宽环境中的M2M（机器对机器）遥测。 Fastapi-mqtt是使用MQTT的客户端。 有关MQTT的更多信息，请参考此处： Fatapi-mqtt环绕模块。 用于MQTT...
FastAPI-Amis-Admin: 一个拥有高性能,高效率,易拓展的fastapi管理后台框架
02-11
astapi-amis-admin是一个拥有高性能,高效率,易拓展的fastapi管理后台框架. 启发自Django-Admin,并且拥有不逊色于Django-Admin的强大功能. 关键特性 性能极高：基于FastAPI, 可享受FastAPI的全部优势。 效率更快：...
fastapi-mail:Fastapi邮件系统发送邮件（单个，批量）附件（单个，批量）
05-12
Fastapi邮件 fastapi-mail简单轻便的邮件系统，发送电子邮件和附件（个人&&批量发送） :hammer: 安装 $ pip install fastapi-mail 文档： 主要功能是： 使用FastApi或使用asyncio模块发送电子邮件 使用FastApi...
fastapi-sqla:备受赞誉的FastAPI SQLAlchemy扩展
04-10
fastapi_sqla.Base一个声明性基类，以在启动时反映数据库表； fastapi_sqla.with_session一个获取sqla会话的依赖项； 在返回响应之前，在请求结束时自动提交/回滚sqla会话； 分页实用程序； Pytest固定装置，易于...
fastapi-template:正确的FastAPI设置可加快您的开发速度！
03-28
在 API 路由中，可以使用这个模型来验证请求体： ```python from fastapi import HTTPException, status from app.models import User @app.post("/users/", response_model=User) async def create_user(user: ...
fastapi-boilerplate:用于基于 API 的访问以及用户管理的 fastAPI 样板
05-30
fastAPI Biolerplate 一个FastAPI项目！ 每个端点都应该通过 API 密钥访问API 密钥具有角色，例如允许或拒绝访问适当的端点多端点项目用户管理以创建新用户、禁用用户、验证电子邮件帐户然后允许 api 访问等... 连接...
fastapi-migrations:Fastapi和Alembic之间的小集成
05-08
Fastapi迁移 该库为alembic提供了一个小的包装。注意根据初始发展。 这不能用于生产库。 这可能意味着： 可能会引入重大更改不良的文档和变更日志尚未完全测试被迫浏览源代码以了解其工作原理等待版本> 0.1.0以便在...
fastapi-jwt-auth:提供JWT Auth支持的FastAPI扩展（安全，易于使用和轻量级）
04-01
FastAPI JWT身份验证 说明文件： 源代码： 特征 提供JWT Auth支持（安全，易于使用和轻量级）的FastAPI扩展，如果您熟悉flask-jwt-extended，此扩展适合您，则导致此扩展受flask-jwt-extended的启发 :grinning_...
fastapi-crud:使用FastAPI框架进行的简单CRUD
04-11
FastAPI CRUD 使用FastAPI框架制作的简单REST Api。 它可以用作非常基本的CRUD样板，它与PostgreSQL数据库一起完全码头化，使用Tortoise作为db ORM以及Aerich进行迁移，具有Pytest，Codecoverage和Black支持，并使用...
fastapi-authz：在FastAPI中使用Casbin，Casbin是功能强大且高效的开源访问控制库
03-04
fastapi-authz fastapi-AuthZ的是授权中间件 ，它是基于 。安装从pip安装pip install fastapi-authz 克隆此仓库git clone https://github.com/pycasbin/fastapi-authz.gitpython setup.py install快速开始该中间件...
fastapi-users:即用型和可自定义的FastAPI用户管理
04-28
FastAPI用户 即用型和可自定义的FastAPI用户管理 说明文件： 源代码： 快速向您的项目添加注册和身份验证系统。 FastAPI用户旨在尽可能地自定义和适应。 特征 可扩展的基本用户模型 即用型注册，登录，重设...
streamlit-fastapi-model-serving:使用streamlit和FastAPI服务PyTorch模型的简单Web应用示例
05-04
streamlit-fastapi-model-serving 和描述了使用Streamlit和FastAPI进行ML模型服务的简单示例。 在开发用于机器学习模型的简单API时，同时具有供其他应用程序调用的后端（带有API文档）和供用户试用该功能的前端...
fastapi-plugins：FastAPI框架插件
02-03
FastAPI框架插件，高性能，易学，快速编写代码，可投入生产fastapi插件FastAPI框架插件芹菜智商记录中健康共同变化查看安装默认情况下仅包含和 memcached添加了 all加在上面pip install fastapi-pluginspip install ...
prometheus-fastapi-instrumentator:检测您的FastAPI应用
04-30
Prometheus FastAPI检测器 适用于FastAPI的可配置和模块化Prometheus Instrumentator。 从安装prometheus-fastapi-instrumentator 。 这是使用预先配置的检测器的快速入门： from prometheus_fastapi_...
fastapi 请求参数校验
最新发布
09-13
FastAPI是一个现代、快速的Web框架，用于构建API，具有自动交互式文档和强类型数据验证。FastAPI使用Pydantic库进行数据验证，Pydantic会根据Python类型提示自动推断出数据的类型，并且在数据到达时进行校验。 在FastAPI中，你可以通过在函数参数前添加类型注解来实现请求参数的校验。FastAPI会自动将请求的数据（包括路径参数、查询参数、请求体等）转换为相应的Python类型，并进行校验。如果校验失败，FastAPI将自动返回一个合适的HTTP错误响应。 例如，如果你有一个API端点，它期望接收一个名为`item_id`的路径参数和一个名为`q`的查询参数，你可以这样做： ```python from fastapi import FastAPI, Path, Query app = FastAPI() @app.get("/items/{item_id}") async def read_item(item_id: int = Path(..., title="The ID of the item to get"), q: str = Query(..., min_length=3, max_length=50, title="Query string"), short: bool = False): return {"item_id": item_id, "q": q, "short": short} ``` 在这个例子中，`item_id`必须是一个整数，`q`是一个长度在3到50个字符之间的字符串。如果请求中提供的数据不符合这些要求，FastAPI会自动抛出`HTTPException`，并且返回一个状态码为422（Unprocessable Entity）的响应。 FastAPI还支持更复杂的校验，比如数字范围、正则表达式匹配、嵌套模型校验等。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值