FastAPI -- 第一弹

Hello World

经典的 Hello World

安装

pip install fastapi
pip install "uvicorn[standard]"

main.py

from typing import Unionfrom fastapi import FastAPIapp = 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/doc （由 Swagger UI生成）
或者
http://127.0.0.1:8000/redoc （由 ReDoc 生成）

参数

路径参数

from fastapi import FastAPIapp = 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 FastAPIapp = FastAPI()@app.get("/items/{item_id}")
async def read_item(item_id: int):	#  通过类型注解，声明 item_id 为 int 类型return {"item_id": item_id}
数据转换
from fastapi import FastAPIapp = 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 FastAPIapp = 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 FastAPIapp = 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 Unionfrom fastapi import FastAPI, Queryapp = 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 Unionfrom fastapi import FastAPI, Queryapp = 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: strdescription: str | None = Noneprice: floattax: float | None = Noneapp = 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 Annotatedfrom fastapi import Body, FastAPI
from pydantic import BaseModel, Fieldapp = FastAPI()class Item(BaseModel):name: str# 通过 Field 为字段 description 增加更多信息 或者校验# TODO： # 		from pydantic import Field# 		from fastapiimport Query，Path，Bodydescription: 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 Annotatedfrom fastapi import Body, FastAPI
from pydantic import BaseModelapp = FastAPI()class Item(BaseModel):name: strdescription: str | None = Noneprice: floattax: float | None = Noneclass User(BaseModel):username: strfull_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 Annotatedfrom fastapi import Body, FastAPI
from pydantic import BaseModelapp = FastAPI()class Item(BaseModel):name: strdescription: str | None = Noneprice: floattax: 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, Unionfrom fastapi import FastAPI
from pydantic import BaseModel, HttpUrlapp = FastAPI()class Image(BaseModel):url: HttpUrlname: strclass Item(BaseModel):name: strdescription: str | None = Noneprice: floattax: float | None = Nonetags: 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, HttpUrlapp = FastAPI()class Image(BaseModel):url: HttpUrlname: strclass Item(BaseModel):name: strdescription: str | None = Noneprice: floattax: float | None = Nonetags: set[str] = set()images: list[Image] | None = Noneclass Offer(BaseModel):name: strdescription: str | None = Noneprice: floatitems: list[Item]@app.post("/offers/")
async def create_offer(offer: Offer):return from fastapi import FastAPI
from pydantic import BaseModel, HttpUrlapp = FastAPI()class Image(BaseModel):url: HttpUrlname: strclass Item(BaseModel):name: strdescription: str | None = Noneprice: floattax: float | None = Nonetags: set[str] = set()images: list[Image] | None = Noneclass Offer(BaseModel):name: strdescription: str | None = Noneprice: floatitems: 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 BaseModelapp = FastAPI()class Item(BaseModel):name: strdescription: str | None = Noneprice: floattax: float | None = Nonemodel_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

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/pingmian/44976.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

【React Hooks原理 - useReducer】

【React Hooks原理 - useReducer】

概述 众所周知useState是基于useReducer来实现状态更新的，在前面我们介绍过useState的原理，所以在这里介绍下useReducer。本文主要从基础使用入手，再进一步从源码来看useReducer实现原理两个方面来介绍useReducer这个Hook。由于本文省略了部…
阅读更多...
Google 面试：从忐忑不安到意外的友善体验

Google 面试：从忐忑不安到意外的友善体验

一、面试前的忐忑不安 站于Google门前，犹如面临生死抉择，心脏如擂鼓般狂跳不止。我手中紧握着精心准备的简历，心中忐忑不安。Google，这一科技巨头的名字，对我而言，既是理想的彼岸，亦是恐惧的深…
阅读更多...
Ozon俄罗斯哪些产品热销中？Ozon7月市场热卖趋势放送

Ozon俄罗斯哪些产品热销中？Ozon7月市场热卖趋势放送

Ozon俄罗斯哪些产品热销工具：D。DDqbt。COm/74rD 据Ozon数据，2023年，在自提服务方面，Ozon投资了100亿扩展自提网络，自提点数量激增至超过5万个，是之前的2.6倍。 物流基础设施方面，Ozon在仓库建…
阅读更多...
【vueUse库Reactivity模块各函数简介及使用方法--上篇】

【vueUse库Reactivity模块各函数简介及使用方法--上篇】

vueUse库是一个专门为Vue打造的工具库，提供了丰富的功能，包括监听页面元素的各种行为以及调用浏览器提供的各种能力等。其中的Browser模块包含了一些实用的函数，以下是这些函数的简介和使用方法： vueUse库Sensors模块各函数简介及使用方法 vueUseReactivity函数1. compute…
阅读更多...
树莓派4B_OpenCv学习笔记19：OpenCV舵机云台物体追踪

树莓派4B_OpenCv学习笔记19：OpenCV舵机云台物体追踪

今日继续学习树莓派4B 4G：（Raspberry Pi，简称RPi或RasPi） 本人所用树莓派4B 装载的系统与版本如下: 版本可用命令 (lsb_release -a) 查询: Opencv 版本是4.5.1： Python 版本3.7.3： ​​ 今日学习&#xff1…
阅读更多...
【数据结构】排序——快速排序

【数据结构】排序——快速排序

前言 本篇博客我们继续介绍一种排序——快速排序，让我们看看快速排序是怎么实现的 💓 个人主页：小张同学zkf ⏩ 文章专栏：数据结构 若有问题 评论区见📝 🎉欢迎大家点赞👍收藏⭐文章 ​ 目录 …
阅读更多...
前端JS特效第30波：jquery图片列表按顺序分类排列图片组效果

前端JS特效第30波：jquery图片列表按顺序分类排列图片组效果

jquery图片列表按顺序分类排列图片组效果&#xff0c;先来看看效果&#xff1a; 部分核心的代码如下&#xff1a; <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> &…
阅读更多...
Profibus协议转Profinet协议网关模块连接智能电表通讯案例

Profibus协议转Profinet协议网关模块连接智能电表通讯案例

一、背景 在工业自动化领域&#xff0c;Profibus协议和Profinet协议是两种常见的工业通讯协议&#xff0c;而连接智能电表需要用到这两种协议之间的网关模块。本文将通过一个实际案例&#xff0c;详细介绍如何使用Profibus转Profinet模块&#xff08;XD-PNPBM20&#xff09;实…
阅读更多...
vue2 实现原生 WebSocket

vue2 实现原生 WebSocket

原生WebSocket&#xff1a; new WebSocket WebSocket | ThinkTS官网 export default {data() {return {socket: null};},created() {// 1. 创建 WebSocket 实例this.socket new WebSocket(ws://localhost:3000);// 2. 监听 WebSocket 连接打开事件this.socket.onopen () &g…
阅读更多...
MySQL常见的几种索引类型及对应的应用场景

MySQL常见的几种索引类型及对应的应用场景

MySQL 提供了多种索引类型&#xff0c;每种索引类型都有其特定的应用场景和优势。以下是 MySQL 中常见的几种索引类型及其具体应用场景&#xff1a; 1. B-Tree 索引 特点&#xff1a; B-Tree&#xff08;Balanced Tree&#xff0c;平衡树&#xff09;是 MySQL 的默认索引类型…
阅读更多...
启航IT之旅：为新生绘制的学习路线图

启航IT之旅：为新生绘制的学习路线图

随着七月的热浪悄悄席卷而来&#xff0c;各地高考成绩陆续放榜&#xff0c;对于刚迈过高考这座独木桥的你们&#xff0c;这不仅仅是一个故事的终章&#xff0c;更是另一段冒险的序曲。特别是那些心中有一团IT火焰燃烧的少年们&#xff0c;暑假的钟声已经敲响&#xff0c;是时候…
阅读更多...
坑3.上传图片（阿里云空间，oss验证）（未验证）

坑3.上传图片（阿里云空间，oss验证）（未验证）

笔记 20240710 未验证&#xff0c;现在还没有阿里云空间&#xff0c;等买个sit环境就可以验证一下。 前端 页面 <!--页面--> <el-form-item label"优惠券图片" prop"couponImg"><single-upload v-model"dataForm.couponImg"&g…
阅读更多...
成员变量与局部变量的区别有哪些？

成员变量与局部变量的区别有哪些？

阅读更多...
2493-04A-6 同轴连接器

2493-04A-6 同轴连接器

型号简介 2493-04A-6是Southwest Microwave的连接器。该连接器是一种端子连接器&#xff0c;采用 1.0 毫米插头&#xff08;公头&#xff09;进行连接。它由多个部件组成&#xff0c;包括过渡块、接地板、螺纹夹紧板、发射针、冷板、底座、电路板和外壳等。 型号特点 外壳&…
阅读更多...
【数据结构】深入理解哈希及其底层数据结构

【数据结构】深入理解哈希及其底层数据结构

目录 一、unordered系列关联式容器 二、底层结构 2.1 哈希的概念 2.2 哈希冲突&#xff08;哈希碰撞&#xff09; 2.3 哈希函数 2.4 哈希冲突处理 2.4.1 闭散列&#xff08;开放定址法&#xff09; 2.4.1.1 代码实现&#xff1a; 2.4.2 开散列&#xff08;链地址法&…
阅读更多...
Visual Studio 2022 安装及使用

Visual Studio 2022 安装及使用

一、下载及安装 VS 官网&#xff1a;Visual Studio: IDE and Code Editor for Software Developers and Teams 下载免费的社区版 得到一个.exe文件 右键安装 选择C开发&#xff0c;并修改安装位置 等待安装 点击启动 二、VS的使用 1.创建项目 打开VS&#xff0c;点击创建新项…
阅读更多...
Python爬虫教程第6篇-使用session发起请求

Python爬虫教程第6篇-使用session发起请求

为什么要使用session 前面介绍了如何使用reqesuts发起请求&#xff0c;今天介绍如何使用session发起请求。session简单理解就是一种会话机制&#xff0c;在浏览器中我们登录完之后&#xff0c;后面再请求服务数据都不需要再登录了&#xff0c;以为Cookie里已经保存了你的会话状…
阅读更多...
【Cesium开发实战】火灾疏散功能的实现，可设置火源点、疏散路径、疏散人数

【Cesium开发实战】火灾疏散功能的实现，可设置火源点、疏散路径、疏散人数

Cesium有很多很强大的功能&#xff0c;可以在地球上实现很多炫酷的3D效果。今天给大家分享一个可自定义的火灾疏散人群的功能。 1.话不多说&#xff0c;先展示 火灾疏散模拟 2.设计思路 根据项目需求要求&#xff0c;可设置火源点、绘制逃生路线、可设置逃生人数。所以点击火…
阅读更多...
荷兰花海元宇宙的探索

荷兰花海元宇宙的探索

在数字科技日新月异的今天&#xff0c;我们有幸见证了一个全新的概念——元宇宙的诞生。元宇宙是一个虚拟世界&#xff0c;它通过高科技手段&#xff0c;将现实世界的各种元素和场景数字化&#xff0c;使人们能够在虚拟世界中体验现实世界的生活。而在这个虚拟世界中&#xff0…
阅读更多...
java设计模式（十六）职责链模式（Chain of Responsibility Pattern）

java设计模式（十六）职责链模式（Chain of Responsibility Pattern）

1、模式介绍&#xff1a; 职责链模式是一种行为设计模式&#xff0c;其中多个对象按顺序处理请求&#xff0c;直到其中一个对象能够处理请求为止。请求沿着链传递&#xff0c;直到有一个对象处理它为止。 2、应用场景&#xff1a; 职责链模式适用于以下场景&#xff1a;请求…
阅读更多...
最新文章

Copyright @ 2022~2023