FastAPI Web框架 [1.11]

已于 2022-08-13 00:36:33 修改
阅读量2.6k 收藏 2
点赞数 1
分类专栏： FastAPI 文章标签： python
于 2022-03-28 17:38:52 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_45253622/article/details/123797445
版权

路径操作配置

#   路径操作配置
#   路径操作装饰器支持多种配置参数。
#   以下参数应直接传递给路径操作装饰器，不能传递给路径操作函数.
#   status_code 状态码:status_code 用于定义路径操作响应中的 HTTP 状态码
#   可以直接传递 int 代码， 比如 404
#   如果记不住数字码的涵义，也可以用 status 的快捷常量
from typing import Optional,Set
from fastapi import  FastAPI,status
from pydantic import BaseModel
app = FastAPI()

class Item(BaseModel):
    name:str
    description:Optional[str] = None
    price:float
    tax:Optional[float] = None
    tags:Set[str] = set()

@app.post("/items/",response_model=Item,status_code=status.HTTP_201_CREATED)
async def create_item(item:Item):
    return item
#   状态码在响应中使用，并会被添加到 OpenAPI 概图
#   也可以使用 from starlette import status 导入状态码。
#   FastAPI 的fastapi.status 和 starlette.status 一样，只是快捷方式。实际上，fastapi.status 直接继承自 Starlette。



#   tags 参数
class Item(BaseModel):
    name: str
    description: Optional[str] = None
    price: float
    tax: Optional[float] = None
    tags: Set[str] = set()      # tags 参数的值是由 str 组成的 list （一般只有一个 str ），tags 用于为路径操作添加标签：

@app.post("/items/",response_model=Item,tags=["items"])
async def create_item(item:Item):
    return item

@app.get("/items/",tags=["items"])
async def read_items():
    return [{"name":"Foo","price":"42"}]

@app.get("/users/",tags=["users"])
async def read_users():
    return [{"username":"johndoe"}]



#   summary 和 description 参数
class Item(BaseModel):
    name: str
    description: Optional[str] = None
    price: float
    tax: Optional[float] = None
    tags: Set[str] = set()

@app.post(
    "/items/",
    response_model=Item,
    summary="Create an item",
    description="Create an item with all the information, name, description, price, tax and a set of unique tags",
)
async def create_item(item: Item):
    return item




#   文档字符串（docstring）
#   描述内容比较长且占用多行时，可以在函数的 docstring 中声明路径操作的描述，FastAPI 支持从文档字符串中读取描述内容。
#   文档字符串支持 Markdown，能正确解析和显示 Markdown 的内容，但要注意文档字符串的缩进。
class Item(BaseModel):
    name: str
    description: Optional[str] = None
    price: float
    tax: Optional[float] = None
    tags: Set[str] = set()

@app.post("/items/", response_model=Item, summary="Create an item")
async def create_item(item: Item):
    """
    Create an item with all the information:

    - **name**: each item must have a name
    - **description**: a long description
    - **price**: required
    - **tax**: if the item doesn't have tax, you can omit this
    - **tags**: a set of unique tag strings for this item
    """
    return item



#   响应描述
#   response_description 参数用于定义响应的描述说明:
class Item(BaseModel):
    name: str
    description: Optional[str] = None
    price: float
    tax: Optional[float] = None
    tags: Set[str] = set()

@app.post(
    "/items/",
    response_model=Item,
    summary="Create an item",
    response_description="The created item",
)
async def create_item(item: Item):
    """
    Create an item with all the information:

    - **name**: each item must have a name
    - **description**: a long description
    - **price**: required
    - **tax**: if the item doesn't have tax, you can omit this
    - **tags**: a set of unique tag strings for this item
    """
    return item
#   注意，response_description 只用于描述响应，description 一般则用于描述路径操作。



#   弃用路径操作
#   deprecated 参数可以把路径操作标记为弃用，无需直接删除：
@app.get("/items/", tags=["items"])
async def read_items():
    return [{"name": "Foo", "price": 42}]

@app.get("/users/", tags=["users"])
async def read_users():
    return [{"username": "johndoe"}]

@app.get("/elements/", tags=["items"], deprecated=True)
async def read_elements():
    return [{"item_id": "Foo"}]
#   通过传递参数给路径操作装饰器 ，即可轻松地配置路径操作、添加元数据。

JSON兼容编码器

在某些情况下，您可能需要将数据类型（如 Pydantic 模型）转换为与 JSON 兼容的类型（如dict、list等）。例如，如果您需要将其存储在数据库中。
为此，FastAPI提供了一个 jsonable_encoder() 功能。

#   使用jsonable_encoder
#   假设您有一个 fake_db 只接收 JSON 兼容数据的数据库, 例如，它不接收datetime对象，因为它们与 JSON 不兼容。
#   因此，datetime必须将对象转换为str包含ISO格式数据的对象,同样，该数据库不会接收 Pydantic 模型（具有属性的对象），只会接收dict.你可以使用jsonable_encoder它。
#   它接收一个对象，如 Pydantic 模型，并返回一个 JSON 兼容版本：
#   python3.10以上
from datetime import datetime
from fastapi import FastAPI
from fastapi.encoders import jsonable_encoder       #导入 jsonable_encoder
from pydantic import BaseModel
app = FastAPI()
fake_db = {}

class Item(BaseModel):
    title: str
    timestamp: datetime
    description: str | None = None

@app.put("/items/{id}")
def update_item(id: str, item: Item):
    json_compatible_item_data = jsonable_encoder(item)
    fake_db[id] = json_compatible_item_data
#   在此示例中，它将 Pydantic 模型转换为dict，并将datetime转换为str。
#   调用它的结果是可以用 Python 标准编码的东西json.dumps()
#   它不会返回str包含 JSON 格式数据（作为字符串）的大数据。它返回一个 Python 标准数据结构（例如 dict），其中的值和子值都与 JSON 兼容。
#   jsonable_encoder实际上是FastAPI内部用来转换数据的。但它在许多其他场景中很有用。

请求体 - 更新数据

用 PUT 更新数据
更新数据请用 HTTP PUT 操作：把输入数据转换为以 JSON 格式存储的数据（比如，使用 NoSQL 数据库时），可以使用 jsonable_encoder。例如，把 datetime 转换为 str。

from typing import List, Optional
from fastapi import FastAPI
from fastapi.encoders import jsonable_encoder
from pydantic import BaseModel
app = FastAPI()

class Item(BaseModel):
    name: Optional[str] = None
    description: Optional[str] = None
    price: Optional[float] = None
    tax: float = 10.5
    tags: List[str] = []

items = {
    "foo": {"name": "Foo", "price": 50.2},
    "bar": {"name": "Bar", "description": "The bartenders", "price": 62, "tax": 20.2},
    "baz": {"name": "Baz", "description": None, "price": 50.2, "tax": 10.5, "tags": []},
}

@app.get("/items/{item_id}", response_model=Item)
async def read_item(item_id: str):
    return items[item_id]

#   用 PUT 更新数据
@app.put("/items/{item_id}", response_model=Item)
async def update_item(item_id: str, item: Item):
    update_item_encoded = jsonable_encoder(item)
    items[item_id] = update_item_encoded
    return update_item_encoded
#   PUT 用于接收替换现有数据的数据。
#   关于更新数据的警告
#   用 PUT 把数据项 bar 更新为以下内容时：
#   {
#     "name": "Barz",
#     "price": 3,
#     "description": None,
# }
#   因为上述数据未包含已存储的属性 "tax": 20.2，新的输入模型会把 "tax": 10.5 作为默认值。
# 因此，本次操作把 tax 的值「更新」为 10.5。




#   用 PATCH 进行部分更新
#   HTTP PATCH 操作用于更新部分数据。
#   即，只发送要更新的数据，其余数据保持不变.
#   PATCH 没有 PUT 知名，也怎么不常用。很多人甚至只用 PUT 实现部分更新。FastAPI 对此没有任何限制，可以随意互换使用这两种操作。
#
#   使用 Pydantic 的 exclude_unset 参数
#   更新部分数据时，可以在 Pydantic 模型的 .dict() 中使用 exclude_unset 参数。
#   比如，item.dict(exclude_unset=True);这段代码生成的 dict 只包含创建 item 模型时显式设置的数据，而不包括默认值。
#   然后再用它生成一个只含已设置（在请求中所发送）数据，且省略了默认值的 dict：
class Item(BaseModel):
    name: Optional[str] = None
    description: Optional[str] = None
    price: Optional[float] = None
    tax: float = 10.5
    tags: List[str] = []

items = {
    "foo": {"name": "Foo", "price": 50.2},
    "bar": {"name": "Bar", "description": "The bartenders", "price": 62, "tax": 20.2},
    "baz": {"name": "Baz", "description": None, "price": 50.2, "tax": 10.5, "tags": []},
}

@app.get("/items/{item_id}", response_model=Item)
async def read_item(item_id: str):
    return items[item_id]

@app.patch("/items/{item_id}", response_model=Item)
async def update_item(item_id: str, item: Item):
    stored_item_data = items[item_id]
    stored_item_model = Item(**stored_item_data)
    update_data = item.dict(exclude_unset=True)
    updated_item = stored_item_model.copy(update=update_data)
    items[item_id] = jsonable_encoder(updated_item)
    return updated_item



#   使用 Pydantic 的 update 参数
#   用 .copy() 为已有模型创建调用 update 参数的副本，该参数为包含更新数据的 dict。
#   例如，stored_item_model.copy(update=update_data)：
#   ..
#   ..
@app.patch("/items/{item_id}", response_model=Item)
async def update_item(item_id: str, item: Item):
    stored_item_data = items[item_id]
    stored_item_model = Item(**stored_item_data)
    update_data = item.dict(exclude_unset=True)
    updated_item = stored_item_model.copy(update=update_data)       # 用 .copy() 为已有模型创建调用 update 参数的副本，该参数为包含更新数据的 dict。
    items[item_id] = jsonable_encoder(updated_item)
    return updated_item
#   更新部分数据小结
#   简而言之，更新部分数据应：

#   1 使用 PATCH 而不是 PUT （可选，也可以用 PUT）；
#   2 提取存储的数据；
#   3 把数据放入 Pydantic 模型；
#   4 生成不含输入模型默认值的 dict （使用 exclude_unset 参数）；只更新用户设置过的值，不用模型中的默认值覆盖已存储过的值。
#   5 为已存储的模型创建副本，用接收的数据更新其属性 （使用 update 参数）。
#   6 把模型副本转换为可存入数据库的形式（比如，使用 jsonable_encoder）。
#   7 这种方式与 Pydantic 模型的 .dict() 方法类似，但能确保把值转换为适配 JSON 的数据类型，例如， 把 datetime 转换为 str 。
#   8 把数据保存至数据库；
#   9 返回更新后的模型。
@app.patch("/items/{item_id}", response_model=Item)
async def update_item(item_id: str, item: Item):
    stored_item_data = items[item_id]
    stored_item_model = Item(**stored_item_data)
    update_data = item.dict(exclude_unset=True)
    updated_item = stored_item_model.copy(update=update_data)
    items[item_id] = jsonable_encoder(updated_item)
    return updated_item
#   实际上，HTTP PUT 也可以完成相同的操作。 但本节以 PATCH 为例的原因是，该操作就是为了这种用例创建的。
#   注意，输入模型仍需验证，因此，如果希望接收的部分更新数据可以省略其他所有属性，则要把模型中所有的属性标记为可选（使用默认值或 None）。
carefree798
关注
  • 1
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
可扩展Web架构与分布式系统
科技D人生
12-21 1604
开放源代码已经成为一些大型网站的基本原则。而在这些网站成长的过程中，一些优秀的实践经验和规则也出现在他们的结构中。本文旨在介绍一些在大型网站结构设计的过程中需要注意的关键问题以及实现目标的基础工作。 本文侧重于介绍网络系统，尽管一些准则在其他分布式系统中也是适用的。 1.1. web分布式系统的设计原则 搭建和运营一个可伸缩的web站点或者应用程序意味着什么？在原始层面上这仅仅是
Hadoop整体框架
热门推荐
爱吃串串的瘦子的博客
07-17 1万+
大数据框架 目录 大数据框架 一、Hodoop 四大组件：HDFS/MapReduce/YARN/Common 二、Zookeeper 三、Hive 四、Spark 五、ETL 六、ngnix 七、Redis 八、Oracle 十一、Jsp/node.js/JQueryEcharts 一、hadoop http://blog.csdn.net/huanglong8/...
fastapi(十)-响应模式
vanexph的博客
03-20 1663
你可以在一下方法中设置相应的response_model参数： @app.get() @app.post() @app.put() @app.delete() eg: from typing import List from fastapi import FastAPI from pydantic import BaseModel app = FastAPI() class Item...
FastAPI Web框架教程 第1章 快速上手
此博客内容主要是小可日常工作中的一些问题解决的记录整理而成
04-01 2696
FastAPI 是一个。
FastAPI完全指南：实现高效、安全的Web开发
最新发布
dzqxwzoe的博客
07-22 973
在快速发展的互联网时代，高效的Web开发变得尤为重要。Python作为一门广受欢迎的编程语言，其众多Web框架中，FastAPI凭借其出色的性能和易用性，成为了一个炙手可热的选择。FastAPI是一个用于构建API的现代、高性能的Web框架，它基于Python3.6+的类型提示，提供了快速、直观且易于学习的API开发体验。响应类型FastAPI允许你定义多种响应类型，包括JSON、HTML、纯文本等。return “文档定制FastAPI允许你自定义这些文档的一些方面，如标题、描述和版本号。
FastAPI Web框架 [1.9]
weixin_45253622的博客
03-26 607
表单数据 from fastapi import FastAPI,Form # 导入 Form # 表单数据 # 接收的不是 JSON，而是表单字段时，要使用 Form app = FastAPI() @app.post("/login/") async def login( username:str = Form(...),password:str = Form(...) # 定义 Form 参数 ): return {"username
FastAPI Web框架 [1.12]
weixin_45253622的博客
04-01 1114
中间件 "中间件"是一个函数，它在每个请求被特定的路径操作处理之前，以及在每个响应返回之前工作。 它接收你的应用程序的每一个请求. 然后它可以对这个请求做一些事情或者执行任何需要的代码. 然后它将请求传递给应用程序的其他部分 (通过某种路径操作). 然后它获取应用程序生产的响应 (通过某种路径操作). 它可以对该响应做些什么或者执行任何需要的代码. 它返回这个响应. 如果你使用了 yield 关键字依赖, 依赖中的退出代码将在执行中间件后执行；如果有任何后台任务(稍后记录), 它们将在执行中间件后运行
【FastAPI基础】14、额外的响应模型
陈建华的博客
03-30 366
额外的响应模型
FastAPI Web框架 [1.6]
weixin_45253622的博客
03-23 2537
模式的额外信息 - 例子 from typing import Optional from fastapi import FastAPI from pydantic import BaseModel app = FastAPI() # 您可以在JSON模式中定义额外的信息。 # # 一个常见的用例是添加一个将在文档中显示的example。 # # 有几种方法可以声明额外的 JSON 模式信息。 # 使用 Config 和 schema_extra 为Pydantic模型声明一个示例 class
从小白到高手---api接口和drf（Django Rest_Framework)使用超详解
wangfan741的博客
10-27 5244
drf（Django Rest_Framework)笔记 1.api接口 为了在团队内部形成共识、防止个人习惯差异引起的混乱，我们需要找到一种大家都觉得很好的接口实现规范，而且这种规范能够让后端写的接口，用途一目了然，减少双方之间的合作成本。 目前市面上大部分公司开发人员使用的接口服务架构主要有：restful、rpc。 rpc: 翻译成中文:远程过程调用[远程服务调用]. http://www.lufei.com/api post请求 action=get_all_student&params=3
Django框架01
m0_72611192的博客
08-31 218
1.版本问题1.X:同步 1.112.X:同步 2.23.X:异步 3.2ps:你无论使用什么版本都可以 区别不大 2.22.启动注意事项1.计算机名称尽量不要有中文2.项目中所有的py文件名尽量不要用中文3.不同版本的python解释器配合不同版本的django 会有一些报错仔细查找一下报错信息 里面会提示你是哪个py文件里面的代码出错找到那一行代码 把逗号删除即可4.一个pycharm窗口只允许有一个项目 不要做项目的嵌套。...
FastAPI是一个高性能易学快速编码可用于生产环境的API开发框架
08-09
FastAPI 是一个高性能，易学，快速编码，可用于生产环境的API开发框架
网络抓取技术工程师面试题
07-08
- **flask**、**fastapi**、**SQLAlchemy**、**Flask-SQLAlchemy**、**vue**等。 **2. Flask-SQLAlchemy与SQLAlchemy的区别** - **Flask-SQLAlchemy**：为Flask应用提供了一个更简单的接口。 - **SQLAlchemy**：...
fastapi 大型应用_FastAPI(高性能Web框架) V0.60.1 官方版
weixin_32049849的博客
12-23 798
FastAPI是一个快速高性能的Web框架，用于基于标准python类型提示使用Python 3.6+构建API。拥有看齐NodeJS的性能，可以采用了FastAPI库来生成一个REST服务器，可以查询该服务器以获得预测。【功能特色】快速编码：将功能开发速度提高约200％至300％。错误少：减少约40％的人为错误(开发人员)。直观：强大的编辑器支持。完成无处不在。调试时间更少。简易：旨在易于使用和...
FastAPI Web框架 [1.10]
weixin_45253622的博客
03-27 5627
请求表单和文件 # 请求表单与文件 from fastapi import FastAPI,File,Form,UploadFile #导入 File 与 Form app = FastAPI() @app.post("/files/") async def create_file( file:bytes = File(...), fileb:UploadFile = File(...), token : str = Form(...) # 定义 Fi
FastAPI，一款实用的web框架
所寫即所思｜一个阿里质量人对测试的所感所悟。
12-10 1940
Java出身的程序员也许知道利用Spring Mvc框架开发一个web应用多麻烦，当然Python也提供一些轻量级的web框架，如Django、Flask。我曾经就使用过Flask开发过mock平台和小工具平台，但是Python栈的web框架缺点就是并发性相对比较差，如果请求量级上来了，服务性能就会差一些，适合做一些对性能要求不是太高的“玩意”。 ​ 当然今天的主角不是上述提到的，而是FastApi，一个用于构建 API 的现代、快速（高性能）的web框架。下面就给大家做一个入门ABC，讲解一下...
FastAPI Web框架 [1.2]
weixin_45253622的博客
03-16 481
学习，记录一下； 请求体 # 当你需要将数据从客户端（例如浏览器）发送给 API 时，你将其作为「请求体」发送。 # 请求体是客户端发送给 API 的数据。响应体是 API 发送给客户端的数据。 # 你的 API 几乎总是要发送响应体。但是客户端并不总是需要发送请求体。 # 我们使用 Pydantic 模型来声明请求体，并能够获得它们所具有的所有能力和优点。 # 要发送数据，你必须使用方法之一：POST（较常见）、PUT、DELETE 或 PATCH。 from fastapi import FastAP
FastAPI Web框架 [1.5]
weixin_45253622的博客
03-22 367
请求体 - 字段&嵌套模型
Django框架详解：Python web开发利器
它的出现源于劳伦斯出版集团为创建新闻网站的需求，自2005年发布以来，Django逐渐发展成为业界备受推崇的框架，被SDTimes评为2013年“API、库和框架”分类的第六名。 Django的主要特点是其重量级框架特性，它提供了...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

carefree798

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

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

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

打赏作者

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

抵扣说明：

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

余额充值