FastAPI 核心概念:构建高性能的 Python Web 服务

FastAPI 核心概念:构建高性能的 Python Web 服务

本文详细解析了如何利用 FastAPI 构建高性能的 Python Web 服务,帮助开发者从零开始创建功能丰富、响应迅速的 API。结合完整的代码示例和分步操作指导,文章深入讲解了 FastAPI 的核心概念,包括路径、操作、装饰器、HTTP 方法等,带来直观清晰的学习体验。通过掌握路径操作装饰器的使用及 Uvicorn 的启动配置,你将能快速构建出强大、可靠的 Python Web 应用,夯实高效 API 开发的基础。

文章目录

  • FastAPI 核心概念:构建高性能的 Python Web 服务
      • 一 简单的 FastAPI 应用示例
      • 二 自定义 FastAPI 的实例对象
      • 三 自定义 uvicorn 启动
      • 四 术语
        • 1 路径
        • 2 操作
      • 五 定义一个路径操作装饰器
        • 1 装饰器
        • 2 解释说明
      • 六 返回内容
      • 七 完整代码示例
      • 八 源码地址

一 简单的 FastAPI 应用示例

# 从fastapi库导入FastAPI类,用于创建FastAPI应用实例
from fastapi import FastAPI# 创建一个FastAPI应用实例,app将作为应用的入口
app = FastAPI()# 使用@app.get("/")装饰器定义一个GET请求的路由
# 当用户访问根路径 ("/") 时,FastAPI会调用下面的函数
@app.get("/")
async def root():# 定义返回的响应内容,这里返回一个JSON对象 {"message": "Hello World"}return {"message": "Hello World"}

FastAPI 是一个为 API 提供功能的 Python 类,直接从 Starlette 继承。可以通过 FastAPI 使用所有 Starlette 的功能。app 同样会被 uvicorn 所引用。

$ uvicorn main:app --reload

注释:

uvicorn main:app 命令含义如下:

  • mainmain.py 文件(Python 模块)。
  • app:在 main.py 文件中通过 app = FastAPI() 创建的对象。
  • --reload:让服务器在更新代码后重新启动,仅在开发时使用该选项。

二 自定义 FastAPI 的实例对象

from fastapi import FastAPI# FastAPI 的实例对象
my_awesome_api = FastAPI()@my_awesome_api.get("/")
async def root():return {"message": "Hello World"}

自定义 my_awesome_api 对象,将 app 改为 my_awesome_api,对应的装饰器也改为 @my_awesome_api

三 自定义 uvicorn 启动

将代码放入 main.py 文件中,然后可以像下面这样运行 uvicorn

$ uvicorn main:my_awesome_api --reloadINFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

如果代码放入了 chapter01.py 文件中,可以像下面运行 uvicorn

$ uvicorn chapter01:my_awesome_api --reload

四 术语

1 路径

路径:也称为端点或路由,指的是 URL 中从第一个 / 起的部分。例如,URL https://example.com/items/foo 的路径是 /items/foo。开发 API 时,路径用于分离 关注点资源

2 操作

操作:指的是一种 HTTP 方法。

常见操作少见操作
POSTOPTIONS
GETHEAD
PUTPATCH
DELETETRACE

在 HTTP 协议中,可以使用上述方法之一(或多种)与每个路径进行通信。在开发 API 时,可以使用特定的 HTTP 方法执行特定行为。

HTTP 方法特定行为
POST创建数据
GET读取数据
PUT更新数据
DELETE删除数据

五 定义一个路径操作装饰器

from fastapi import FastAPIapp = FastAPI()# 一个路径操作装饰器
@app.get("/")
async def root():return {"message": "Hello World"}

@app.get("/") 告诉 FastAPI 下方的函数负责处理如下访问请求:

  • 请求路径为 /
  • 使用 GET 操作
1 装饰器

@decorator 语法在 Python 中被称为 装饰器装饰器 告诉 FastAPI 下方的函数对应着 路径 / 加上 GET 操作,是一个 路径操作装饰器。FastAPI 中的装饰器对应 HTTP 方法如下:

路径操作装饰器HTTP 方法
@app.get()GET
@app.post()POST
@app.put()PUT
@app.delete()DELETE
@app.options()OPTIONS
@app.head()HEAD
@app.patch()PATCH
@app.trace()TRACE

FastAPI 没有强制要求操作有任何特定含义,可以随意使用任何操作(HTTP 方法),但一般在实际项目中习惯使用 GET/POST。

2 解释说明

这是一个路径操作函数:

  • 路径/
  • 操作GET
  • 函数:位于装饰器下方的函数
from fastapi import FastAPIapp = FastAPI()@app.get("/")
async def root():return {"message": "Hello World"}

这是一个 Python 函数,每当 FastAPI 接收一个使用 GET 方法访问 URL / 的请求时,该函数会被调用。在这个例子中,这是一个 async 函数,也可以将其定义成常规函数而不使用 async def

from fastapi import FastAPIapp = FastAPI()@app.get("/")
def root():return {"message": "Hello World"}

有关 async defdef 的更多信息可以查看 官方文档 。

六 返回内容

from fastapi import FastAPIapp = FastAPI()@app.get("/")
async def root():return {"message": "Hello World"}

可以返回 dictlist,或者单个值,如 strint 等。当前示例返回 JSON

七 完整代码示例

from fastapi import FastAPI# 启动命令:uvicorn chapter01:app --reload 
app = FastAPI()@app.get("/")
async def root():return {"message": "Hello World! app"}# 启动命令:uvicorn chapter01:my_awesome_api --reload 
my_awesome_api = FastAPI()@my_awesome_api.get("/")
async def root():return {"message": "Hello World!my_awesome_api"}

八 源码地址

详情见:GitHub FastApiProj

引用: FastAPI 文档

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

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

相关文章

Redis 实战 问题

前言 相关系列 《Redis & 目录》《Redis & 实战 & 源码》《Redis & 实战 & 总结》《Redis & 实战 & 问题》 什么缓存击穿?怎么避免? 所谓缓存击穿是指请求因缓存失效而直接访问数据库的情况,由于热点数据访…

Flutter CustomScrollView 效果-顶栏透明与标签栏吸顶

CustomScrollView 效果 1. 关键组件 CustomScrollView, SliverOverlapAbsorber, SliverPersistentHeader 2. 关键内容 TLDR SliverOverlapAbsorber 包住 pinned为 true 的组件 可以被CustomScrollView 忽略高度。 以下的全部内容的都为了阐述上面这句话。初阶 Flutter 开发知…

Litctf-web

Litctf-web exx xxe&#xff0c; <?xml version"1.0" encoding"utf-8"?> <!DOCTYPE xxe [<!ELEMENT name ANY ><!ENTITY xxe SYSTEM "file:///flag" >]><user><username>&xxe;</username> …

线程模型介绍

线程模型的介绍 线程有三种模型&#xff1a;N:1用户线程模型&#xff0c;1:1核心线程模式&#xff0c;N:M混合线程模型 POSIX: Portable Operating System Interface(可移值操作系统接口) N&#xff1a;1用户线程模型 线程的实现建立在进程控制的机制之上&#xff0c;有用户…

2024 Rust现代实用教程:1.3获取rust的库国内源以及windows下的操作

文章目录 一、使用Cargo第三方库1.直接修改Cargo.toml2.使用cargo-edit插件3.设置国内源4.与windows下面的rust不同点 参考 一、使用Cargo第三方库 1.直接修改Cargo.toml rust语言的库&#xff1a;crate 黏贴至Cargo.toml 保存完毕之后&#xff0c;自动下载依赖 拷贝crat…

ML 系列:第 18 部 - 高级概率论:条件概率、随机变量和概率分布

文章目录 一、说明二、关于条件概率2.1 为什么我们说条件概率&#xff1f;2.2 为什么条件概率在统计学中很重要 三、 随机变量的定义3.1 定义3.2 条件概率中的随机变量 四、概率分布的定义五、结论 一、说明 条件概率是极其重要的概率概念&#xff0c;它是因果关系的数学表述&…

基于springboot的社区团购系统设计与实现

一、项目背景 网络交易&#xff08;Electronic Commerce&#xff09;&#xff1a;是指实现整个贸易过程中各阶段的贸易活动的电子化。网络交易是一种多技术的集合体。其业务可包括&#xff1a;信息交换、售后服务、销售、电子支付、运输、组建虚拟企业、公司和贸易伙伴可以共同…

挑战Java面试题复习第4天,坚持就是胜利

挑战第 4 天 Excption与Error包结构OOM 知识点SOF 知识点线程程序进程知识点有些字段不想序列化&#xff0c;怎么办&#xff1f;说说 IO 流Java IO与 NIO的区别 Excption与Error包结构 运行时异常&#xff08;RuntimeException&#xff09;&#xff1a; 包括RuntimeException…

一文读懂系列:SSL加密流量检测技术详解

SSL加密流量检测功能的主要目的是为了对加密流量做解密处理&#xff0c;并对解密后的流量做内容安全检查&#xff08;比如反病毒、入侵防御、URL远程查询、内容过滤、文件过滤和邮件过滤等&#xff09;和审计&#xff08;防止信息泄露&#xff09;。接下来我们详细介绍SSL加密流…

dependencyManagement保持maven的多模块依赖版本一致

在maven的多模块中, 为保持jar包在每个子模块中版本一致, 一般会有两种选择&#xff1a; 在父pom的dependencies标签中声明一个jar&#xff0c;每个子模块都会默认继承该jar 如果只有部分子模块用到了一个jar, 则会选择将该jar坐标信息声明在父pom的dependencyManagement标签中…

axis 参数的方向

axis0&#xff1a;表示沿着行的方向进行操作&#xff0c;即对每一列进行操作。 axis1&#xff1a;表示沿着列的方向进行操作&#xff0c;即对每一行进行操作。 示例&#xff1a; import numpy as np# 创建一个二维数组 array np.array([[1, 2, 3],[4, 5, 6],[7, 8, 9] ])axis0…

golang的循环引用解决方法

循环引用是指在数据结构中&#xff0c;两个或多个实体相互引用&#xff0c;形成一个闭环。例如&#xff0c;在 Golang 的结构体中&#xff0c;如果结构体 A 包含结构体 B 的实例&#xff0c;而结构体 B 又包含结构体 A 的实例&#xff0c;这种情况就称为循环引用。以下是关于循…

【C++】关联式容器

1.Set和Map 1.1 set的介绍 set是一个常用的关联式容器&#xff0c;它存储唯一的元素&#xff0c;这些元素默认情况下按照升序排序。其底层是一种自平衡的二叉搜索树(红黑树)。 set元素的键值就是实值&#xff0c;实值就是键值。set的元素允许插入删除但是不允许修改(具有const…

Spring Cloud Function快速入门Demo

1.什么是Spring Cloud Function&#xff1f; Spring Cloud Function是一个具有以下高级目标的项目&#xff1a; 通过功能促进业务逻辑的实现。将业务逻辑的开发生命周期与任何特定的运行时目标脱钩&#xff0c;以便可以将相同的代码作为Web终结点&#xff0c;流处理器或任务来…

第3章 继承与多态

Java面向对象程序设计-T3(继承与多态) 一、封装 1、概述 封装是指隐藏对象的属性和实现细节,仅对外提供公共访问方式。 public class Student {//1、私有化属性private String name;private int age;//2、提供公共方法供外部访问//传入数据public void setName(String nam…

荣誉证书PSD素材(59套免费)

本作品提供荣誉证书PSD素材下载&#xff0c;格式为PSD&#xff1b; 请使用软件Photoshop进行编辑&#xff0c;作品中文字及图均可以通过软件修改和编辑&#xff1b; 点击下载: 荣誉证书PSD素材

Java三大特性之多态

多态是Java的三大特性之一&#xff0c;它指的是同一个方法名字&#xff0c;在不同的对象中有不同的实现方式。具体来说&#xff0c;多态有两种表现形式&#xff1a;静态多态&#xff08;编译时多态&#xff0c;也称为重载&#xff09;和动态多态&#xff08;运行时多态&#xf…

第T6周:Tensorflow实现好莱坞明星识别

&#x1f368; 本文为&#x1f517;365天深度学习训练营 中的学习记录博客&#x1f356; 原作者&#xff1a;K同学啊 目标 具体实现 &#xff08;一&#xff09;环境 语言环境&#xff1a;Python 3.10 编 译 器: PyCharm 框 架: &#xff08;二&#xff09;具体步骤 1.查询…

Spring6框架搭建(自用)

一、什么是Spring 众所不周知&#xff0c;Spring就是爪哇人的春天&#xff0c;但是在框架程序设计之前都绕不开javaWeb 1.javaWeb框架发展史 1、ServletJSPJavaBean(跳转页面、业务逻辑判断、数据库查询) 2、MVC三层架构(M Model pojo(User)V-view(USP)C-(controller-servl…

linux-UART

参考博客 https://blog.csdn.net/m0_38106923/article/details/126024970?sharetypeblog&shareId126024970&sharereferAPP&sharesourceweixin_40933496&sharefromlink 1.串口 UART的全称是Universal Asynchronous Receiver and Transmitter&#xff0c;即异步…