FastAPI简单使用

最新推荐文章于 2025-10-10 21:10:02 发布
原创 最新推荐文章于 2025-10-10 21:10:02 发布 · 887 阅读 · 24 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#fastapi #数据库

FastAPI简单使用

1 介绍

FastAPI是一个高性能的Web框架，支持自动数据验证**、**自动文档生成和异步。

https://fastapi.tiangolo.com/

Uvicorn是一款基于ASGI协议的高性能Python Web服务器，专为异步框架设计，支持FastAPI、Starlette等现代Web框架。

1.1 异步编程

在Python中异步编程中，关键字async 和 await很重要：

async 的作用

  • 用于定义一个协程函数（coroutine function）。
  • 调用 async 函数时，不会立即执行函数体，而是返回一个 协程对象（coroutine object），需要被事件循环调度执行。

await的作用

  • 用于暂停当前协程，等待一个 awaitable 对象（如另一个协程、asyncio.sleep()、asyncio.Future 等）完成。
  • 不会阻塞事件循环，而是让出控制权，允许其他协程运行。
  • await 只能在 async def 函数中使用。

示例

import asyncio

# 异步调用数据
async def fetch_data():
    print("Hello")
    await asyncio.sleep(5)
    print("World")

# 调用不会执行，而是返回协程对象
coro = fetch_data()
print(type(coro))


async def main():
    # 等待 fetch_data() 完成
    result = await fetch_data()
    print("获取到的结果：", result)

asyncio.run(main())

1.2 异步和多线程的区别

在 Python 中，异步（asyncio） 和 多线程（threading） 都可以实现“同时干多件事”，但它们的底层机制、性能表现和适用场景完全不同。下面用一句话总结：

异步是“单线程内协作式并发”，多线程是“操作系统级抢占式并发”。

IO 高并发用 async，简单并发用 thread，CPU 密集用 process

维度异步（asyncio）多线程（threading）
核心机制事件循环 + 协程（用户态调度）操作系统线程（内核态调度）
线程数单线程（默认）多线程
切换开销极低（用户态切换）较高（内核态上下文切换）
GIL 影响不受影响（单线程）受 GIL 限制（CPU 密集任务无法并行）
适合任务高并发 I/O 密集（如爬虫、API 请求）少量 I/O 密集或简单并发任务
编程难度较高（需写 async/await）较低（同步代码即可）
数据竞争无（单线程）有（需加锁、同步）

1.3 异步≠立即响应客户端

假设你有这样一个异步路径操作函数：

from fastapi import FastAPI
import asyncio

app = FastAPI()

@app.get("/")
async def read_root():
    # 模拟一个耗时的 I/O 操作，比如数据库查询
    await asyncio.sleep(2)
    return {"message": "Hello World"}

当一个请求 GET / 到来时，会发生以下步骤：

  1. 接收请求：FastAPI 从客户端接收到 HTTP 请求。
  2. 创建任务：FastAPI 创建一个任务来执行你的 read_root 函数。
  3. 事件循环接管：FastAPI 将你的函数（一个协程）交给 ASGI 服务器（如 Uvicorn 或 Hypercorn）内部的事件循环。
  4. 执行直到第一个 await：事件循环开始执行 read_root 函数。
  5. 遇到 await（关键点！）：
    • 当执行到 await asyncio.sleep(2) 时，函数会说：“我要睡眠 2 秒，在这期间我什么都不做，你去忙别的吧！”
    • 此时，事件循环会立即挂起这个函数。
    • 事件循环不会阻塞等待，它会立刻去处理其他正在排队的任务（可能是另一个来自客户端的请求，或者是其他异步操作）。
  6. 等待完成：2 秒后，睡眠操作完成。
  7. 恢复执行：事件循环在适当的时机（当它轮询到睡眠完成的事件时）重新唤醒 read_root 函数，并从 await 之后的地方继续执行。
  8. 返回响应：函数执行到最后，返回 {"message": "Hello World"}。
  9. 发送响应：FastAPI 将这个 Python 字典转换为 JSON，并通过 HTTP 响应发送回客户端。

1.4 同步 vs 异步

为了更好地理解，我们看一个同步的例子：

import time

@app.get("/sync")
def read_root_sync():
    # 模拟一个耗时的 I/O 操作
    time.sleep(2)  # 注意：这里是同步的 sleep
    return {"message": "Hello World Sync"}

对于这个同步端点：

  • 当执行到 time.sleep(2) 时，整个工作线程被彻底阻塞 2 秒。
  • 在这 2 秒内，这个线程不能做任何其他事情，即使有新的请求进来，它也无法处理。
  • 如果并发请求数超过了工作线程数，新请求就必须排队等待，导致性能急剧下降。

1.5 FastAPI的特点

  • FastAPI 的异步机制并不能让你的业务逻辑执行得更快。一个需要 2 秒的数据库查询，在异步函数里仍然需要 2 秒才能拿到结果。
  • 它的巨大优势在于提升服务器的并发吞吐量。通过在等待 I/O 时释放线程，让有限的服务器资源可以同时服务更多的客户端连接。
  • 你“立即”得到的是事件循环的解放，而不是给客户端的最终响应。

因此，你应该将异步用于那些主要是 I/O 密集型 的操作（如网络请求、数据库查询、文件读写），而不是 CPU 密集型 的操作（如复杂的数学计算）。对于 CPU 密集型任务，你应该使用 def 定义普通函数，并让 FastAPI 在单独的线程池中运行它们。

2 简单使用

2.1 安装依赖环境

pip install "fastapi[standard]"
pip install uvicorn

2.2 简单使用FastAPI

import asyncio
from typing import Union

import uvicorn
from fastapi import FastAPI, BackgroundTasks, Query
from pydantic import BaseModel, Field

app = FastAPI()

"""
FastAPI中参数校验的关键字有Field、Query、Path。
其中Field和Query的作用相似，不同点是字段 Field，参数 Query/Path，写在模型里 → Field；写在函数签名里 → Query/Path。
三个点 (...) 被称为 Ellipsis（省略号），它是一个内置常量，主要作为占位符和切片工具使用。
"""


class Item(BaseModel):
    name: str
    price: float
    is_offer: Union[bool, None] = None


class TaskInfo(BaseModel):
    task_id: int = Field(..., ge=1, le=120, description="任务编号")


@app.get("/read")
def read_item(item_id: int = Query(..., ge=1, le=120, description="数据编号"), data: Union[str, None] = None):
    return {"item_id": item_id, "data": data}


@app.post("/update/{item_id}")
async def update_item(item_id: int, item: Item):
    # time.sleep(10)
    await asyncio.sleep(4)
    return {"item_id": item_id, "item_name": item.name}


async def long_running_task(task_id: int):
    # 模拟耗时操作
    await asyncio.sleep(10)
    print(f"任务 {task_id} 完成")


@app.post("/task")
async def create_task(task_info: TaskInfo, background_tasks: BackgroundTasks):
    # 将任务添加到后台执行
    background_tasks.add_task(long_running_task, task_info.task_id)

    return {
        "status": "任务已接收",
        "task_id": task_info.task_id,
        "message": "任务正在后台处理"
    }


if __name__ == '__main__':
    uvicorn.run(app, host="127.0.0.1", port=3000)

2.3 返回值

（1）接口文档地址

http://127.0.0.1:3000/docs

（2）读取数据地址

http://127.0.0.1:3000/read

（3）更新数据，不会立刻返回值

http://127.0.0.1:3000/update/1

参数

{
    "name": "张三",
    "price": 0.12,
    "is_offer": true
}

（4）异步任务，立刻返回值。

http://127.0.0.1:3000/task

MasonYyp
关注
关于fastapi框架的异步
laomao9112的博客
12-20 4116
fastapi中的异步
Python高性能web框架--Fastapi快速入门
景天科技苑
02-26 2万+
fastapi是建立在Starlette和Pydantic基础上的，Pydantic是一个基于Python类型提示来定义数据验证、序列化和文档的库。 Starlette是一种轻量级的ASGI框架/工具包，是构建高性能Asyncio服务的理性选择。 - 快速：可与 NodeJS 和 Go 比肩的极高性能（归功于 Starlette 和 Pydantic），是最快的 Python web 框架之一。 - 高效编码：提高功能开发速度约 200％ 至 300％。 - 更少bug：减少约 40％ 的人为bug
【FastAPI】学习笔记
最新发布
Tom299的博客
10-10 1027
FastAPI是一个基于Starlette和Pydantic的现代Python Web框架，具有高性能、类型提示支持、自动生成API文档和异步特性。其核心优势在于使用异步I/O和Uvicorn ASGI服务器，性能接近Node.js和Go。环境搭建建议使用虚拟环境，并通过三种方式启动服务：直接运行Python文件、命令行启动或调试模式启动。FastAPI自动生成交互式API文档，可通过/docs路径访问。开发时需注意端口占用问题，可通过终止进程或更改端口号解决。
【FastAPI】从0开始学FastAPI！一篇搞懂！
热门推荐
qq_39172059的博客
03-06 4万+
FastAPI是一个现代、快速（高性能）的python web框架，基于标准的python类型提示，使用python3.6+构建的web框架。 FastAPI的架构为RESTful风格，RESTful是一种网络应用程序的设计风格和开发方式，其特点为每一个URI代表一种资源，客户端通过GET、POST、PUT、DELETE等动作，对服务器端资源进行操作。
FastAPI完全指南：实现高效、安全的Web开发
walkskyer的博客
12-20 4603
在快速发展的互联网时代，高效的Web开发变得尤为重要。Python作为一门广受欢迎的编程语言，其众多Web框架中，FastAPI凭借其出色的性能和易用性，成为了一个炙手可热的选择。FastAPI是一个用于构建API的现代、高性能的Web框架，它基于Python 3.6+的类型提示，提供了快速、直观且易于学习的API开发体验。响应类型FastAPI允许你定义多种响应类型，包括JSON、HTML、纯文本等。
如何评价最近爆红的FastAPI？
m0_57290404的博客
08-01 2万+
一度觉得sanic是pythonweb框架的未来，支持异步，性能好，类flask的语法，代码简单，没想到被fastapi截胡了，fastapi在github的上星速度非常快。它在怎么样把后端api做好的这件事情上，做的比sanic更全面，更彻底。是用于构建WebAPI的现代、开源、快速、高性能的Web框架，它基于Python3.6+标准类型提示，支持异步，正如它的名字，FastAPI就是为构建快速的API而生。...
快速提升代码性能：FastAPI多线程的利用
LiamHong_的博客
08-30 2771
本文介绍了 FastAPI 框架中多线程的使用方法。通过合理地应用多线程，我们可以提高应用的并发性能，让用户获得更好的体验。同时，我们还讨论了多线程可能遇到的问题，并给出了一些建议来避免这些问题。
精选资源
fastapi_cache:简单缓存FastAPI
05-06
将简单的轻量级缓存系统实现为FastAPI中的依赖项。 安装 pip install fastapi-cache 用法示例 from fastapi import Depends , FastAPI from fastapi_cache import caches , close_caches from fastapi_cache . ...
fastAPI简单使用
weixin_45541986的博客
05-31 3433
目录前言一、fastAPI是什么？二、安装1.fastapi的安装(此处用的是阿里云镜像源)2.测试一下三、使用1.声明路径参数2. 声明路径参数有效值3. 声明路径参数为路径4. 声明params参数5. 请求体(如post请求会用到的data) 前言 利用python fastAPI框架搭建简便的api服务 一、fastAPI是什么？ FastAPI 是一个用于构建 API 的现代、快速（高性能）的 web 框架，使用 Python 3.6+ 并基于标准的 Python 类型提示。总之它可以简单快
FastAPI 入门使用指南
SWZ156的博客
11-05 987
FastAPI 提供了一种简单、高效的方式来构建 Web 应用和 API。它支持异步编程，自动生成文档，适合构建微服务架构。希望这篇入门指南能帮助您快速上手 FastAPI，创建您的第一个 API 项目！
fastapi的swagger文档静态文件
06-10
FastAPI是一种现代、快速（高性能）的Web框架，用于构建API，使用Python 3.6+类型提示。它具有许多内置特性，比如自动交互式API文档。Swagger是一种用于设计、构建、记录和使用RESTful Web服务的框架。Swagger UI则...
精选资源
streamlit-fastapi-model-serving:使用streamlit和FastAPI服务PyTorch模型的简单Web应用示例
05-04
和描述了使用Streamlit和FastAPI进行ML模型服务的简单示例。 在开发用于机器学习模型的简单API时，同时具有供其他应用程序调用的后端（带有API文档）和供用户试用该功能的前端可能会很有用。 在此示例中，我们为...
深入解析FastAPI多线程：加速代码执行效率
NHB456789的博客
03-16 4409
本文介绍了 FastAPI 框架中多线程的使用方法。通过合理地应用多线程，我们可以提高应用的并发性能，让用户获得更好的体验。同时，我们还讨论了多线程可能遇到的问题，并给出了一些建议来避免这些问题。这些资料，对于【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴上万个测试工程师们走过最艰难的路程，希望也能帮助到你！
关于fastapi的协程与多线程设置
laomao9112的博客
02-08 3471
关于fastapi中的协程与多线程设置
fastapi 实践（四）非阻塞启动
cliffordl的专栏
05-10 2852
参考： https://www.cnblogs.com/selfcs/p/17240902.html。
redis+celery（python）解决fastapi(示例)异步任务，定时任务详解
qq_51718617的博客
11-13 4845
简介老样子，我指定给你教会咯，学不会你来找我简介fastapi你访问一个接口，当这个接口执行一个非常耗时的任务的时候，其他的接口根本没办法访问，直接给你卡死，除非等这个接口的程序运行完。为什么，因为同步和异步的问题。那么我告诉你今天这个问题不存在了。
fastAPI、多线程、通过http上传文件
weixin_47276979的博客
09-28 624
【代码】fastAPI、多线程、通过http上传文件。
实践探讨：FastAPI中的异步函数调用与并发处理
全世界的博客
05-17 2947
在 Python 中，使用async def关键字定义异步函数。这些函数可以通过await关键字来调用其他异步操作，如数据库查询、网络请求等。await asyncio.sleep(1) # 模拟耗时操作，如数据库查询import asyncio async def fetch_data(user_id : int) : await asyncio . sleep(1) # 模拟耗时操作，如数据库查询 return f"User data for {在这个例子中，get_user路由会异步调用。
FastApi-实现异步接口(4)
Python进阶专栏《爬虫实战进阶》，《Pyppeteer从入门到精通》原创作者
01-21 887
本文是该专栏的第4篇，后面会持续分享FastApi以及项目实战的各种干货知识。提到异步接口，在项目需求应用中，也是非常常见的。比如说在“邮件发送，短信验证码发送，文件上传，文件下载，甚至类似于繁琐数据计算的发起等等领域，都有涉及应用到异步接口。为什么要用到异步接口，主要在于每个任务需要处理的时间是不确定的，不能让接口调用者或用户一直处于等待状态，而我们要做的就是立刻给用户一个状态反馈。而本文，笔者将基于FastApi通过实际代码例子，来创建一个FastApi的异步接口。具体细节部分以及注意事项，跟着笔者直接
Python FastAPI中文使用手册
FastAPI 的设计哲学是简单、易于使用。它具有以下特点： 1. **自动交互式文档**：FastAPI 使用 OpenAPI（以前称为 Swagger）和 ReDoc 创建交互式 API 文档。 2. **数据校验**：基于请求体、路径参数和查询参数，...
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值