fastapi教程（一）：初识 fastapi

FastAPI 是一个用于构建 API 的现代、快速（高性能）的 web 框架，使用 Python 并基于标准的 Python 类型提示。

关键特性:

  • 快速：可与 NodeJS 和 Go 并肩的极高性能（归功于 Starlette 和 Pydantic）。最快的 Python web 框架之一。
  • 高效编码：提高功能开发速度约 200％ 至 300％。
  • 更少 bug：减少约 40％ 的人为（开发者）导致错误。
  • 智能：极佳的编辑器支持。处处皆可自动补全，减少调试时间。
  • 简单：设计的易于使用和学习，阅读文档的时间更短。
  • 简短：使代码重复最小化。通过不同的参数声明实现丰富功能。bug 更少。
  • 健壮：生产可用级别的代码。还有自动生成的交互式文档。
  • 标准化：基于（并完全兼容）API 的相关开放标准：OpenAPI (以前被称为 Swagger) 和 JSON Schema。

简单来体验一下：
环境：

  • Python 3.11
  • Windows 10
  • fastapi 0.68.0

1，安装 fastapi

pip install fastapi

2，安装一个 ASGI 服务器

pip install "uvicorn[standard]"
  • 生产环境可以使用 Uvicorn 或者 Hypercorn。

ASGI(Asynchronous Server Gateway Interface)是 Python 异步服务器网关接口的缩写。
它定义了异步编程风格的 Python Web 服务器与 Web 服务器和应用程序之间的标准接口。
ASGI 旨在解决传统 Python Web 服务器(如WSGI)在高并发和长连接场景下的不足，使用异步编程模型来提高服务器的并发处理能力。
ASGI服务器具有以下几个关键特点:

  • 异步和事件驱动：ASGI 服务器采用异步非阻塞的编程模型，可以高效处理大量并发连接，避免进程/线程阻塞。它使用事件循环机制，在有事件到来时处理，否则释放资源做其他事情。
  • 支持长连接和WebSocket：ASGI 服务器本身支持长连接和 WebSocket 协议，可用于构建实时通信应用，如在线聊天室、协作平台等。
    标准统一接口：ASGI 定义了统一的服务器端接口规范，使Web服务器、中间件和应用程序之间松散耦合，易于拓展和维护。
    高性能：相比传统 WSGI，ASGI 编程模型使用异步协程可以大幅降低上下文切换和内存开销，从而提高并发性能。

目前支持 ASGI 的服务器有 Uvicorn、Daphne、Hypercorn 等，应用框架包括 Django Channels、FastAPI 等。ASGI 正在逐渐取代 WSGI 成为 Python Web 应用开发的新标准，特别适合于需要高并发、实时双向通信的应用场景。

3，创建一个 main.py 文件

from typing import Unionfrom fastapi import FastAPI# 创建 FastAPI 实例
app = FastAPI()# 定义路由，处理 get 请求
@app.get("/")
# 定义路由处理函数
async def read_root():return {"Hello": "World"}# 定义路由，处理 get 请求，接收一个路径参数 item_id
@app.get("/items/{item_id}")
async def read_item(item_id: int,q: str = 'default',
):return {"item_id": item_id, "q": q}

4，运行项目

$ uvicorn main:app --reload
INFO:     Will watch for changes in these directories: ['I:\\Python\\Web\\FastAPI\\fastApiProject1']
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [14776] using WatchFiles
INFO:     Started server process [24944]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
  • main：main.py 文件（一个 Python “模块”）。
  • app：在 main.py 文件中通过 app = FastAPI() 创建的对象。
  • –reload：让服务器在更新代码后重新启动。仅在开发时使用该选项。

5，浏览器访问路由

访问 http://127.0.0.1:8000/ 可以在页面看到路由处理函数返回的数据：
在这里插入图片描述
访问 http://127.0.0.1:8000/items/5?q=somequery 可以在页面看到路由处理函数返回的数据：
在这里插入图片描述

6，体验类型声明的优势

浏览器访问 http://127.0.0.1:8000/docs 可以到达 API 界面：
在这里插入图片描述

但是国内可能打不开。
fastapi访问/docs和/redoc接口文档显示空白或无法加载
FastAPI 自动文档Swagger UI 打不开。显示空白

打开这个页面，我们可以看到非常详细的 API 描述：
在这里插入图片描述

  • item_id：integer类型，是一个路径参数，而且是必需的。
  • q：string 类型，是一个查询参数，而且不是必需的。

这是怎么做到的？回到代码：

@app.get("/items/{item_id}")
def read_item(item_id: int,q: str = 'default',
):return {"item_id": item_id, "q": q}

路由装饰器中定义了路径 /items/{item_id}，路径参数 item_id 在路由处理函数中明确定义为 int 数据类型，且未指定默认值，路径参数是用户必须传递的。

路由处理函数中，q 明确定义为 str 数据类型，且赋予了一个默认值 default，这种不是路径参数的路由处理函数参数就是查询参数。

  • 把默认值设为 None 即可声明可选的查询参数

最重要的特征就是，我们为参数添加了类型声明，这样做有非常多好处：

  1. 由 FastAPI 通过类型声明自动将解析请求中的字符串转为声明的数据类型：
    在这里插入图片描述
    2，更方便地利用编辑器的自动提示：
    在这里插入图片描述

7，借助 Pydantic 完成数据验证

多数情况我们会用 POST（最常用）、PUT 操作来发送数据，具体就是将数据放在这些请求的请求体中。
既然路径参数和查询参数都可以通过定义数据类型来完成默认的类型转化和校验，那么作为传述数据主要载体的请求体，自然也支持数据类型的定义带来的好处，响应体也是如此！

请求体和响应体的数据定义需要使用 pandatic，这是一个流行的数据验证工具。使用 Pydantic 模型声明请求体，能充分利用它的功能和优点：

  • 以 JSON 形式读取请求体。（在必要时）把请求体转换为对应的类型
  • 校验数据：数据无效时返回错误信息，并指出错误数据的确切位置和内容
  • 把接收的数据赋值给参数 item：把函数中请求体参数的类型声明为 Item，还能获得代码补全等编辑器支持
  • 为模型生成 JSON Schema，在项目中所需的位置使用
  • 用于 API 文档 UI
from fastapi import FastAPI
from pydantic import BaseModelclass Item(BaseModel):name: strdescription: str | None = Noneprice: floattax: float | None = Noneapp = FastAPI()@app.post("/items/")
async def create_item(item: Item):return item
  • 修改代码并保存后，服务器将会自动重载（因为在上面的步骤中你向 uvicorn 命令添加了 --reload 选项来启动服务）

我们通过使继承 pydantic 的 BaseModel 类来定义了一个类，通常会将它称为模型，在这个模型中我们定义了一些字段及其数据类型，然后我们用这个模型定义一个查询参数的类型。

  • 使用Pydantic 模型的参数，是请求体。
  • 与声明查询参数一样，包含默认值的模型属性是可选的，否则就是必选的。默认值为 None 的模型属性也是可选的。

上述模型声明如下 JSON 对象（即 Python 字典）：

{"name": "Foo","description": "An optional description","price": 45.2,"tax": 3.5
}

运行项目，使用接口调试工具进行调试：
在这里插入图片描述
如果请求体数据必填项缺失：

发送：
{"name": "Foo","description": "An optional description","tax": 3.5
}
返回：
{"detail": [{"type": "missing","loc": ["body","price"],"msg": "Field required","input": {"name": "Foo","description": "An optional description","tax": 3.5}}]
}

如果数据类型错误：

发送：
{"name": "Foo","description": "An optional description","price": "error type","tax": 3.5
}
返回：
{"detail": [{"type": "float_parsing","loc": ["body","price"],"msg": "Input should be a valid number, unable to parse string as a number","input": "error type"}]
}

这就是 pandatic 实现请求体数据校验的最大好处！

接下来看看响应体：可以在任意的路径操作中使用 response_model 参数来声明用于响应的模型。

from typing import Anyfrom fastapi import FastAPI
from pydantic import BaseModel, EmailStrapp = FastAPI()class UserIn(BaseModel):username: strpassword: stremail: EmailStrfull_name: str | None = Noneclass UserOut(BaseModel):username: stremail: EmailStrfull_name: str | None = None@app.post("/user/", response_model=UserOut)
async def create_user(user: UserIn) -> Any:return userif __name__ == "__main__":import uvicornuvicorn.run(app)

即便我们的路径操作函数将会返回包含密码的相同输入用户，但我们已经将 response_model 声明为了不包含密码的 UserOut 模型，FastAPI 将会负责过滤掉未在输出模型中声明的所有数据。

发送：
{"username": "Jonas Vingegaard","password": "123456","email": "test@test.com","full_name": "Jonas Vingegaard Rasmussen"
}
返回：
{"username": "Jonas Vingegaard","email": "test@test.com","full_name": "Jonas Vingegaard Rasmussen"
}发送：
{"username": "Jonas Vingegaard","password": "123456","email": "test@test.com"
}
返回：
{"username": "Jonas Vingegaard","email": "test@test.com","full_name": null
}发送：
{"username": "Jonas Vingegaard","password": "123456"
}
返回：
{"detail": [{"type": "missing","loc": ["body","email"],"msg": "Field required","input": {"username": "Jonas Vingegaard","password": "123456"}}]
}

8，使用数据库

任何SQLAlchemy支持的数据库，如：

  • PostgreSQL
  • MySQL
  • SQLite
  • Oracle
  • Microsoft SQL Server，等等其它数据库

首先你需要安装SQLAlchemy:

pip install sqlalchemy

创建目录：

└── sql_app├── __init__.py├── crud.py├── database.py├── main.py├── models.py└── schemas.py

定义数据库：

# sql_app/database.pyfrom sqlalchemy import create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker# 为 SQLAlchemy 定义数据库 URL地址
SQLALCHEMY_DATABASE_URL = "sqlite:///./sql_app.db"
# SQLALCHEMY_DATABASE_URL = "postgresql://user:password@postgresserver/db"# 创建 SQLAlchemy 引擎
engine = create_engine(SQLALCHEMY_DATABASE_URL, connect_args={"check_same_thread": False}
)# 创建一个SessionLocal类
SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)# 创建一个Base类
Base = declarative_base()

创建数据库模型:

# sql_app/models.pyfrom sqlalchemy import Boolean, Column, ForeignKey, Integer, Stringfrom sql_app.database import Baseclass User(Base):__tablename__ = "users"__table_args__ = {'extend_existing': True}id = Column(Integer, primary_key=True)email = Column(String, unique=True)hashed_password = Column(String)is_active = Column(Boolean, default=True)

创建 Pydantic 模型:

# sql_app/schemas.pyfrom pydantic import BaseModelclass UserBase(BaseModel):email: strclass UserCreate(UserBase):password: strclass User(UserBase):id: intis_active: boolclass Config:orm_mode = True

主程序——controller：

# main.pyfrom fastapi import Depends, FastAPI, HTTPException
from sqlalchemy.orm import Session
from sql_app import crud, models, schemas
from sql_app.database import SessionLocal, enginemodels.Base.metadata.create_all(bind=engine)app = FastAPI()# Dependency
def get_db():db = SessionLocal()try:yield dbfinally:db.close()@app.post("/users/", response_model=schemas.User)
def create_user(user: schemas.UserCreate, db: Session = Depends(get_db)):db_user = crud.get_user_by_email(db, email=user.email)if db_user:raise HTTPException(status_code=400, detail="Email already registered")return crud.create_user(db=db, user=user)@app.get("/users/", response_model=list[schemas.User])
def read_users(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)):users = crud.get_users(db, skip=skip, limit=limit)return users@app.get("/users/{user_id}", response_model=schemas.User)
def read_user(user_id: int, db: Session = Depends(get_db)):db_user = crud.get_user(db, user_id=user_id)if db_user is None:raise HTTPException(status_code=404, detail="User not found")return db_userif __name__ == "__main__":import uvicornuvicorn.run(app)

添加 crud 操作实现：

# crud.pyfrom sqlalchemy.orm import Sessionfrom sql_app import models, schemasdef get_user(db: Session, user_id: int):return db.query(models.User).filter(models.User.id == user_id).first()def get_user_by_email(db: Session, email: str):return db.query(models.User).filter(models.User.email == email).first()def get_users(db: Session, skip: int = 0, limit: int = 100):return db.query(models.User).offset(skip).limit(limit).all()def create_user(db: Session, user: schemas.UserCreate):fake_hashed_password = user.password + "notreallyhashed"db_user = models.User(email=user.email, hashed_password=fake_hashed_password)db.add(db_user)db.commit()db.refresh(db_user)return db_user

去启动程序，访问 API 页面：
在这里插入图片描述
POST 创建一些数据，然后就能 GET 它们了。

9，文件的上传与下载

简单的文件上传：

from urllib.parse import quotefrom fastapi import FastAPI, UploadFile
from fastapi.responses import StreamingResponseapp = FastAPI()@app.post("/uploadfile/")
async def create_upload_file(file: UploadFile):# 分块将大文件保存到磁盘file_object = file.filefile_name = file.filename# 判断文件夹是否存在，不存在则创建import osif not os.path.exists("files"):os.mkdir("files")# 将文件写入到文件夹with open(f"files/{file_name}", "wb") as f:while True:# 读取文件chunk = file_object.read(10000)if not chunk:breakf.write(chunk)return {"filename": file.filename}if __name__ == "__main__":import uvicornuvicorn.run(app)

大文件下载：


def file_iterator(file_path, chunk_size=8192):with open(file_path, mode="rb") as file_like:while True:chunk = file_like.read(chunk_size)if not chunk:breakyield chunk# 流式下载文件
@app.get("/downloadfile/")
async def download_file(file_name: str):file_path = f"files/{file_name}"# 判断文件是否存在import osif not os.path.exists(file_path):return {"msg": "file not found"}else:headers = {'Content-Disposition': f'attachment; filename="{quote(file_name)}"'}return StreamingResponse(file_iterator(file_path),media_type="application/octet-stream",headers=headers)

10，部署 fastapi 项目

先收集项目依赖：

pip freeze > requirements.txt

然后将项目发送到服务器。
在服务器安装 ASGI 服务器：

pip install "uvicorn[standard]"

然后运行服务器程序：

uvicorn main:app --host 0.0.0.0 --port 80

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

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

相关文章

甘肃旅游服务平台的设计

甘肃旅游服务平台的设计

管理员账户功能包括：系统首页，个人中心，管理员管理，公告信息管理，景点管理，酒店管理，基础数据管理，美食管理 前台账户功能包括：系统首页，个人中心&#xff0…
阅读更多...
HTML静态网页成品作业(HTML+CSS)——故宫介绍网页(4个页面)

HTML静态网页成品作业(HTML+CSS)——故宫介绍网页(4个页面)

🎉不定期分享源码，关注不丢失哦 文章目录 一、作品介绍二、作品演示三、代码目录四、网站代码HTML部分代码 五、源码获取 一、作品介绍 🏷️本套采用HTMLCSS，未使用Javacsript代码，共有4个页面。 二、作品演示 三、代…
阅读更多...
Docker：安装RediSearch全文搜索

Docker：安装RediSearch全文搜索

1、简述 在本文中，我们将介绍如何使用Docker快速、简便地安装RediSearch，Redis的全文搜索模块。RediSearch提供了高效的全文搜索功能，通过Docker安装，可以轻松地在任何环境中部署和管理RediSearch。 官网地址：https:/…
阅读更多...
【GUI】LVGL无操作系统移植以及移植过程错误处理

【GUI】LVGL无操作系统移植以及移植过程错误处理

目录 介绍 1. 删除源码 2. 导入lvgl到项目screen_mcu中 3. keil添加分组和头文件 4. 移植显示 5. 移植触摸 6. 添加测试案例 6.1. 测试按钮 6.2. 测试音乐界面 7. 提供时钟 错误处理 L6218E错误 出现花屏 屏幕颜色不对 内存分配 介绍 本文 主要介绍GD32移植…
阅读更多...
BlockingQueue详解(含动画演示)

BlockingQueue详解(含动画演示)

目录 BlockingQueue详解0、BlockingQueue简介BlockingQueue接口中方法注释BlockingQueue的实现，总结计划 1、ArrayBlockingQueue简介2、ArrayBlockingQueue的继承体系3、ArrayBlockingQueue的构造方法①、 ArrayBlockingQueue(int capacity)②、ArrayBlockingQueue(…
阅读更多...
计算机组成原理 —— 存储系统（概述）

计算机组成原理 —— 存储系统（概述）

计算机组成原理 —— 存储系统（概述） 存储系统按层次划分按照存储介质分类按照存储方式分类按照信息可更改性分类根据信息的可保存性分类存储器性能指标 我们今天来学习计算机组成原理中的存储系统： 存储系统 存储系统是计算机系统中用于存…
阅读更多...
vue实现的商品列表网页

vue实现的商品列表网页

一、商品列表效果如下 二、代码&#xff1b; vue实现的商品列表网页 &#xff0c; 图片在vue项目的Public文件夹里的 imgs中 <template><div class"common-layout"><!-- el-container:外层容器。 当子元素中包含 <el-header> 或 <el-foo…
阅读更多...
mysql：简单理解mysql mvcc的可重复读

mysql：简单理解mysql mvcc的可重复读

# 原理 假设有这样的sql begin select&#xff08;或update、insert、delete&#xff09; ... commit当执行【begin】的时候&#xff0c;标记有一个新事务要开始&#xff0c;但是事务还没有真正开始&#xff0c;事务id还没有产生当执行事务里面的第一个sql语句时&#xff08;…
阅读更多...
java之url任意跳转漏洞

java之url任意跳转漏洞

1 漏洞介绍 URLRedirect url重定向漏洞也称url任意跳转漏洞&#xff0c;网站信任了用户的输入导致恶意攻击&#xff0c;url重定向主要用来钓鱼&#xff0c;比如url跳转中最常见的跳转在登陆口&#xff0c;支付口&#xff0c;也就是一旦登陆将会跳转任意自己构造的网站&#xf…
阅读更多...
Xshell7免费版下载安装使用

Xshell7免费版下载安装使用

​一、下载安装​ 1.打开官网下载 https://www.xshell.com/zh/free-for-home-school/ 2.选择合适的下载路径&#xff0c;点击下载按钮&#xff0c;然后按照提示完成安装。 二、Xshell7的使用&#xff0c;Xhell连接Linux 1.连接之前&#xff0c;确保在Linux中开启SSH。参考&a…
阅读更多...
YOLOv8中的C2f模块

YOLOv8中的C2f模块

文章目录 一、结构概述二、模块功能 一、结构概述 C2f块:首先由一个卷积块(Conv)组成&#xff0c;该卷积块接收输入特征图并生成中间特征图特征图拆分:生成的中间特征图被拆分成两部分&#xff0c;一部分直接传递到最终的Concat块&#xff0c;另一部分传递到多个Botleneck块进…
阅读更多...
QT基础 - 文本文件读写

QT基础 - 文本文件读写

目录 零. 前言 一.读取文件 二. 写入文件 三. 和二进制读写的区别 零. 前言 在 Qt 中&#xff0c;对文本文件进行读写操作是常见的任务之一。这对于保存和加载配置信息、处理数据文件等非常有用。 Qt 提供了多种方式来读写文本文件&#xff0c;使得文件操作变得相对简单和…
阅读更多...
SwiftUI 6.0（iOS 18）ScrollView 全新的滚动位置（ScrollPosition）揭秘

SwiftUI 6.0（iOS 18）ScrollView 全新的滚动位置（ScrollPosition）揭秘

概览 在只有方寸之间大小的手持设备上要想体面的向用户展示海量信息&#xff0c;滚动视图&#xff08;ScrollView&#xff09;无疑是绝佳的“东牀之选”。 在 SwiftUI 历史的长河中&#xff0c;总觉得苹果对于 ScrollView 视图功能的升级是在“挤牙膏”。这不&#xff0c;在本…
阅读更多...
spire.Pdf 将pdf转成image

spire.Pdf 将pdf转成image

一、nuget安装 <ItemGroup><PackageReference Include"Spire.PDF" Version"10.6.7" /></ItemGroup> 二、直接上代码 using Microsoft.AspNetCore.Mvc; using Microsoft.Extensions.Logging; using System; using System.IO;namespace …
阅读更多...
乱弹篇（35）掩耳盗铃与两三十年

乱弹篇（35）掩耳盗铃与两三十年

成语“ 掩耳盗铃 ”&#xff0c;比喻自己欺骗自己&#xff0c;明明是掩盖不住的事情偏要想法子掩盖。它多用来讽刺那些做事不想让别人知道&#xff0c;却偏偏又引起他人注意的人。 现在网络上以新浪微博和邪恶的“800727”为典型的自媒体平台和其掌控者&#xff0c;就是现代版…
阅读更多...
提升研发效率：三品PLM解决方案在汽车汽配行业的实践

提升研发效率：三品PLM解决方案在汽车汽配行业的实践

随着全球汽车市场的快速发展&#xff0c;中国汽车汽配行业迎来了前所未有的发展机遇。然而&#xff0c;在这一过程中&#xff0c;企业也面临着诸多挑战&#xff0c;如研发能力的提升、技术资料管理的复杂性、以及跨部门协作的困难等。为了应对这些挑战&#xff0c;三品产品生命…
阅读更多...
模式分解算法-满足3NF的无损且保持函数依赖的分解算法、满足BCNF的无损连接分解算法

模式分解算法-满足3NF的无损且保持函数依赖的分解算法、满足BCNF的无损连接分解算法

一、引言 1、对指定的关系模式&#xff0c;若范式级别较低&#xff0c;为第一范式或第二范式&#xff0c;由于存在数据冗余或更新异常问题&#xff0c;在实际中一般是不可用的&#xff0c;关系模式的规范化就是将满足低一级的关系模式分解为若干满足高一级范式的关系模式的集合…
阅读更多...
Python轻松设置Excel单元格数字显示格式

Python轻松设置Excel单元格数字显示格式

Excel作为强大的数据处理与分析工具&#xff0c;不仅能够存储大量数据&#xff0c;还支持复杂的数据处理与可视化功能。而如何恰当地展示Excel表格中的数据是Excel文件制作的关键之一。这便涉及到Excel单元格数字格式的设置。数字格式不仅关乎数据的美学呈现&#xff0c;如货币…
阅读更多...
聊聊 C# dynamic 类型，并分享一个将 dynamic 类型变量转为其它类型的技巧和实例

聊聊 C# dynamic 类型，并分享一个将 dynamic 类型变量转为其它类型的技巧和实例

前言 dynamic 是一种有别于传统变量类型的动态类型声明&#xff0c;刚开始接触可能在理解上会有些困难&#xff0c;可以简单地把它理解为一个盲盒&#xff0c;你可以任意猜测盒子有什么东西&#xff0c;并认为这些东西真正存在而进行处理&#xff0c;等到真正打开时&#xff0…
阅读更多...
网上的流量卡真的可以免费领取吗？

网上的流量卡真的可以免费领取吗？

网上的流量卡真的可以免费领取吗&#xff1f;当然可以&#xff0c;目前运营商推出的流量卡都是可以免费领取的。 有很多朋友私信给小编&#xff0c;听说流量卡是免费领取的就觉得不太靠谱&#xff0c;其实这种想法是不对的&#xff0c;首先大家要换位思考一下&#xff0c;如果我…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023