【Python】FastAPI学习记录（一）

最新推荐文章于 2024-05-19 23:31:32 发布
最新推荐文章于 2024-05-19 23:31:32 发布
阅读量188 收藏
点赞数 3
分类专栏： python 文章标签： python fastapi 运维开发
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Meepoljd/article/details/135158878
版权

参数、请求体

使用记录

查询参数

字符串校验

导入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,
        # 接口的title
        title="Query string",
        # 接口描述
        description="Query string for the items to search in the database that have a good match",
        # 参数最小长度，当然也有max_length
        min_length=3,
    ),
):
    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
    if q:
        results.update({"q": q})
    return results

对于请求参数在URL里面的名称可以使用alias设置别名，这样就会过去url里面的item-query参数：

@app.get("/items/")
async def read_items(q: Union[str, None] = Query(default=None, alias="item-query")):
    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
    if q:
        results.update({"q": q})
    return results

路径参数

设置路径参数使用Path

建议使用带Annotated的版本

from typing import Annotated

from fastapi import FastAPI, Path, Query

app = FastAPI()


@app.get("/items/{item_id}")
async def read_items(
    item_id: Annotated[int, Path(title="The ID of the item to get")],
    q: Annotated[str | None, Query(alias="item-query")] = None,
):
    results = {"item_id": item_id}
    if q:
        results.update({"q": q})
    return results

路径参数是必须的，因为这是作为路由的一部分

参数校验

数值校验

  • gt：大于（greater than）
  • ge：大于等于（greater than or equal）
  • lt：小于（less than）
  • le：小于等于（less than or equal）

数值校验参数，可以在Path和Query类以及其他一些类中使用

from fastapi import FastAPI, Path, Query

app = FastAPI()


@app.get("/items/{item_id}")
async def read_items(
    *,
    item_id: int = Path(title="The ID of the item to get", ge=0, le=1000),
    q: str,
    size: float = Query(gt=0, lt=10.5),
):
    results = {"item_id": item_id}
    if q:
        results.update({"q": q})
    return results

请求体

可选请求体

如下可以声明一个可选请求体：

from typing import Annotated

from fastapi import FastAPI, Path
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: Annotated[int, Path(title="The ID of the item to get", ge=0, le=1000)],
    q: str | None = None,
    item: Item | None = None,
):
    results = {"item_id": item_id}
    if q:
        results.update({"q": q})
    if item:
        results.update({"item": item})
    return results

多个请求体

可以声明多个请求体

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


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):
    results = {"item_id": item_id, "item": item, "user": user}
    return results

这样声明下，FastAPI期望一个类似下面内容的请求体：

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

请注意，即使 item 的声明方式与之前相同，但现在它被期望通过 item 键内嵌在请求体中。

使用Body

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, importance: Annotated[int, Body()]
):
    results = {"item_id": item_id, "item": item, "user": user, "importance": importance}
    return results

上面的例子中，引入了Body，他和Query与Path类似，在这里importance将会被内嵌于请求体中，而不是查询参数，按照这样的设置，FastAPI期待如下的请求体：

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

Body也可以用来包裹单个Pydantic 模型 作为请求体，针对Item而言，如果希望得到下面的请求体：

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

则可以使用如下代码：

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, item: Annotated[Item, Body(embed=True)]):
    results = {"item_id": item_id, "item": item}
    return results

字段校验

使用Field进行字段设置，这个从pydantic引入，而不是FaskAPI，Field的可用参数和Body等类似

from typing import Annotated

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

app = FastAPI()


class Item(BaseModel):
    name: str
    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

嵌套模型

很多时候请求体不是简单的层次，可能会出现多种数据类型组合的模式，比如某个字段是list：

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
    tags: list = []


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

一般来说，可能对list的字段类型会做限制，比如限制为str，且不能重复，那么可以用set方法：

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
    # 使用set，即使传入的list是有重复的也会被处理去重
    tags: set[str] = set()


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

也可以在模型中嵌套模型，如下就是在Item中嵌套了Image：

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

# 声明了Image
class Image(BaseModel):
    url: str
    name: str


class Item(BaseModel):
    name: str
    description: str | None = None
    price: float
    tax: float | None = None
    tags: set[str] = set()
    # image是一个Image模型类型
    image: 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

这样可以接收一个嵌套的json请求体：

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

嵌套时，也可以使用Pydantic中提供的类型进行简单的校验，比如url这种字段，一般是固定格式的，可以使用HttpUrl进行校验：

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()
    image: 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
Meepoljd
关注
  • 3
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
python项目深度学习的web端多格式纠错系统.zip
04-17
这个Python项目是一个基于深度学习的Web端多格式纠错系统，它利用PaddleNLP和FastAPI等先进技术，旨在提高Web内容的准确性和可靠性。以下是该项目的资源介绍： 1. **技术框架**：项目使用了PaddlePaddle作为深度学习框架，结合Taskflow进行错误标记提示，以及FastAPI进行高效、通用的模型Web端部署。 2. **多格式支持**：系统不仅支持基本的文本格式，还扩展到了对Word文档的识别和OCR图片识别，这使得它能够适应更多类型的输入数据。 3. **错误修正与提示**：系统能够对识别出的错误字进行标记提示，并且支持对修正结果的保存，便于用户查看和记录。 4. **应用价值**：中文文本纠错是自然语言处理中的一个基础任务，该系统能够有效地检测和修复Web端内容中的错误，提升用户体验和信息的准确性。 5. **研究意义**：该项目探索了深度学习技术在Web端多格式纠错领域的应用，为Web开发和内容管理提供了创新的解决方案，有助于提升Web端的质量和可靠性。 6. **资源内容**：项目资源可能包括完整的源代码、系统文档说明以及必要的数据集等，这些资源可以帮助理解项目的构建细节和运行机制。 总的来说，通过这个系统，开发者可以深入了解如何将深度学习技术应用于实际问题，特别是在自然语言处理和Web开发领域的结合。对于有志于在这些领域进行深入研究和开发的人士来说，这个项目是一个很好的实践案例。
FastAPI 教程翻译 - 用户指南 10 - 请求主体 - 嵌套模型
人生苦短，我用Python！
05-27 748
FastAPI 教程翻译 - 用户指南 10 - 请求主体 - 嵌套模型 FastAPI Tutorial - User Guide - Body - Nested Models With FastAPI, you can define, validate, document, and use arbitrarily deeply nested models (thanks to Pydantic). 使用 FastAPI，您可以定义、验证、文档和使用任意深度嵌套的模型（感谢 Pydantic）。 List
fastapi-jupytercon-2020：在model.fit之后，在您部署之前：Jupyter中具有FastAPI的原型！
02-12
在model.fit之后，在部署之前：在Jupyter中使用FastAPI创建原型！ 作者Ryan Herr，为2020年JupyterCon 您想要部署scikit学习模型。 怎么办？ 您可以在Jupyter中为模型创建API！ 您将学习 ，这是一个具有自动交互式文档的Python Web框架。 我们将使用类型提示来验证输入，然后转换为数据框，以对模型进行新的预测。 您将拥有一个可运行的API原型，可以在笔记本上运行并准备部署！ 看视频 谈话记录在的。 查看完整的应用 转到 活页夹上的工作 转到 在本地工作 克隆此仓库并更改目录 git clone https://github.com/rrherr/fastapi-jupytercon-2020.git cd fastapi-jupytercon-2020 创建并激活虚拟环境 python -m venv env source en
【Python开发】FastAPI 07：Depends 依赖注入
尹煜的博客
06-04 4963
依赖注入是一种设计模式，用于降低程序组件之间的耦合度。它通过将组件之间的依赖关系从代码中分离出来，使得组件可以更加灵活地被替换、修改或重用。假设有一个类A需要使用类B的功能，如果在A类中直接实例化B类，那么A类和B类之间的依赖关系就会很紧密，难以达到解耦的目的。而使用依赖注入的方式，A类不再直接实例化B类，而是将B类的实例通过构造函数、属性、或者接口等方式注入到A类中。共享业务逻辑（复用相同的代码逻辑）共享数据库连接实现安全、验证、角色权限等……上述场景均可以使用依赖注入。
Python进阶---FastAPI框架
木易巷的小博客
08-21 2433
Python进阶---FastAPI框架
FastAPI Tortoise-ORM annotate()方法的简单使用
weixin_45319250的博客
04-05 604
方法来查询所有的书籍，并返回一个字典格式的列表，其中包含了每本书的ID、名称、作者、价格和打折后的价格。方法来添加一个新的计算列，这个计算列代表了每本书打折后的价格。下面是一个使用Tortoise-ORM的。在上面的代码中，我们定义了一个。字段，并将其乘以0.8。
FastAPI请求体-多个参数
silk_java的专栏
12-07 626
首先，我们需要导入所需的库。我们将使用FastAPI、Path和Annotated来处理路由和参数，并使用BaseModel和Union来自定义数据模型。
FastAPI从入门到实战（7）——请求体函数的参数设置
欢迎自九陌而来的你做客九陌斋！
11-27 645
上一篇记录了FastAPI中声明请求体的相关内容，本文记录一下零碎的函数特性和参数特性相关内容。
im-being-pydantic:学习Pydantic + FastAPI-并深入研究python类型和pydantic
05-04
FastAPI和Pydantic ... 如果您要开始一个新的API项目，我强烈建议您尝试FastAPI。 是的，我有偏见...滑梯要以幻灯片形式查看笔记本，只需运行以下命令。 jupyter nbconvert pydantic.ipynb --to slides --post serve
机器学习：机器学习教程（主要在Python3中）
02-03
这是一个不断更新的存储库，记录了个人在学习数据科学，机器学习相关主题方面的历程。 目标：以Jupyter Notebook格式介绍机器学习内容。 内容旨在在数学符号，使用python的科学堆栈（包括numpy，numba，scipy，...
MMAction2 是一个基于PyTorch实现用于视频动作理解的开源工具箱-python
06-18
OpenMMLab的下一代动作理解工具箱和基准 ... 简介 MMAction2 是一个基于 PyTorch 的用于动作理解的开源工具箱。... 良好的测试和记录我们提供详细的文档和 API 参考，以及单元测试。 许可证 这个项目是在 Apa
通过 Python FastAPI 开发一个快速的 Web API 项目
Saki_Python的博客
09-15 686
FastAPI是一个用于开发网络 API 的新的 Python 框架，在过去几年中得到了普及。如果你打算使用 Python 进行 Web 开发，熟悉 FastAPI 将对你有好处。文档源码快速：可与NodeJS和Go比肩的极高性能（归功于 Starlette 和 Pydantic）。最快的 Python web 框架之一。高效编码：提高功能开发速度约 200％ 至 300％。更少 bug：减少约 40％ 的人为（开发者）导致错误。智能：极佳的编辑器支持。处处皆可自动补全，减少调试时间。简单。
Python FastAPI库：构建高性能Web应用
白帽阿叁的博客
10-13 205
引言：Python FastAPI是一个快速（高性能）的Web框架，用于构建基于Python的RESTful API。它结合了Python的快速执行速度和标准化的API开发，使得我们能够快速构建出高效、安全和易于维护的Web应用程序。本文将详细介绍如何使用Python FastAPI库，包括安装、基本用法、路由操作、请求和响应处理、数据库集成等内容，并提供丰富的代码示例。
Python-FastAPI框架使用介绍
wt334502157的博客
04-16 956
FastAPI 关键特性 1. **快速高效**：基于 Starlette 和 Pydantic 构建，具有高性能和低延迟的特点，支持异步处理请求，利用 Python 的协程提高并发性能。 2. **简单易用**：使用标准的 Python 类型注解来定义 API 的输入和输出参数，无需编写大量的文档和验证代码。 3. **自动生成文档**：通过访问 `/docs` 路径可以查看自动生成的交互式 API 文档，包含了每个端点的详细说明、请求和响应的模型结构以及示例请求和响应。 4. **数据验证**：利用
Python Web 框架 FastAPI 简介
Saki_Python的博客
10-18 567
FastAPI 是一个现代 Web 框架，速度相对较快，用于基于标准 Python 类型提示使用 Python 3.7+ 构建 API。FastAPI还帮助我们自动为我们的Web服务生成文档，以便其他开发人员可以快速了解如何使用它。本文档简化了 Web 服务的测试，以了解它需要哪些数据以及它提供什么。FastAPI 具有许多功能，例如它可以显着提高开发速度，还可以减少代码中的人为错误。它很容易学习并且完全可以用于生产。
python学习-使用pandas库分析excel表，并导出所需的表
SixSix的自留地
05-16 318
使用pandas库分析excel表中多个子表的数据
python项目如何读取配置文件（配置端口号，ip等等）
weixin_42759398的博客
05-16 264
然后在文件夹内新建一个config.ini。这样就能将配置和代码分离。
使用Python操作excel单元格——在单元格中插入公式
xll_007的博客
05-16 538
使用Python操作excel单元格——在单元格中插入公式。 通过使用Python的openpyxl库，来操作excel单元格，在单元格中插入公式的操作。把学习的过程分享给大家。大佬勿喷！
python数据分析numpy基础之intersect1d求数组交集
sinat_34735632的博客
05-19 272
python的numpy库的intersect1d(x,y)函数，计算x和y的公共元素，并返回去重后的有序结果。相当于求两个数组中的交集，并且进行去重和排序。numpy.intersect1()查找两个数组的公共元素，并且返回去重后的有序结果。ar1，ar2：必选，列表、元组、数组；如果是多维则自动转一维数组；assume_unique：可选，bool，默认False，若为True则可以加快计算素材，此时ar1和ar2需为元素唯一的数组，否则结果不会去重；
python fastapi 上传图片
最新发布
05-21
Python FastAPI是一个高性能的Web框架，可以方便快捷地构建Web API。在FastAPI中，上传图片可以通过使用Python标准库中的multipart/form-data来实现。 以下是一个使用FastAPI上传图片的示例代码： ```python from ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

Meepoljd

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

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

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

打赏作者

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

抵扣说明：

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

余额充值