当前位置：首页 > news >正文

如何使用 FastAPI 框架创建 RESTful API ？

news 来源：原创 2025/5/23 14:23:28

FastAPI是一个现代、快速（高性能）的Web框架，用于构建API，它基于Python 3.6+的类型提示功能，可以自动生成交互式API文档（使用Swagger UI或ReDoc），并且支持异步编程。

二、创建第一个FastAPI应用

首先，确保你已经安装了FastAPI和Uvicorn（一个ASGI服务器）。你可以使用pip来安装它们：

pip install fastapi uvicorn

接下来，创建一个简单的FastAPI应用：

from fastapi import FastAPIapp = FastAPI()@app.get("/")
async def read_root():return {"Hello": "World"}# 运行应用
# 在命令行中执行以下命令：
# uvicorn main:app --reload

在这个例子中，我们创建了一个FastAPI实例app，并定义了一个GET请求的路由/，当访问这个路由时，会返回一个JSON响应。

三、定义数据模型

在实际开发中，我们经常需要处理复杂的数据结构。FastAPI支持使用Pydantic来定义数据模型，这样可以方便地进行数据验证和序列化。

from pydantic import BaseModelclass Item(BaseModel):name: strdescription: str = Noneprice: floattax: float = None@app.post("/items/")
async def create_item(item: Item):return item

在这个例子中，我们定义了一个Item数据模型，并在/items/路由中使用它来接收POST请求的数据。

四、处理路径参数和查询参数

FastAPI允许你轻松地处理路径参数和查询参数。

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

在这个例子中，{item_id}是一个路径参数，q是一个可选的查询参数。

五、实际开发建议

使用异步编程：FastAPI支持异步编程，这可以提高应用的性能和响应能力。在处理I/O密集型任务时，尽量使用异步方法。
合理使用依赖注入：FastAPI支持依赖注入，这可以帮助你更好地组织代码和提高代码的可重用性。例如，你可以将数据库连接或身份验证逻辑作为依赖项注入到路由处理函数中。
利用Pydantic进行数据验证：Pydantic提供了强大的数据验证功能，确保接收到的数据符合预期的格式和类型。这可以减少因数据问题导致的错误和安全漏洞。
编写详细的API文档：FastAPI可以自动生成交互式API文档，这对于团队协作和API的维护非常有帮助。确保你的API文档清晰、详细，并及时更新。

六、实际开发注意事项

性能优化：虽然FastAPI本身已经非常高效，但在处理大量请求或复杂计算时，仍需注意性能优化。例如，可以使用缓存来减少数据库查询次数，或者使用异步任务队列来处理耗时的任务。
安全性考虑：在设计API时，需要考虑安全性问题。例如，对敏感数据进行加密传输，实施身份验证和授权机制，以及防止常见的Web攻击（如SQL注入、跨站脚本攻击等）。
版本控制：随着项目的迭代和发展，API可能会发生变化。为了确保向后兼容性，建议对API进行版本控制。你可以在URL中包含版本号，或者使用HTTP头部来指定版本。
错误处理：设计良好的错误处理机制对于提高用户体验和便于调试非常重要。FastAPI允许你自定义异常处理器，以便在发生错误时返回统一的响应格式。
测试：编写单元测试和集成测试是确保API稳定性和可靠性的关键步骤。FastAPI提供了方便的测试工具，你可以使用它来编写和运行测试用例。

七、代码示例：完整的FastAPI应用

下面是一个更完整的FastAPI应用示例，包括数据模型、路由处理、依赖注入和错误处理：

from fastapi import FastAPI, Depends, HTTPException
from pydantic import BaseModel
from typing import Listapp = FastAPI()# 数据模型
class Item(BaseModel):name: strprice: floatclass ItemList(BaseModel):items: List[Item]# 模拟数据库
fake_db = {}# 依赖项：获取所有项目
def get_all_items() -> List[Item]:return list(fake_db.values())# 路由：获取所有项目
@app.get("/items/", response_model=ItemList)
async def read_items(items: List[Item] = Depends(get_all_items)):return {"items": items}# 路由：创建新项目
@app.post("/items/", response_model=Item)
async def create_item(item: Item):if item.name in fake_db:raise HTTPException(status_code=400, detail="Item already exists")fake_db[item.name] = item.dict()return item# 路由：获取单个项目
@app.get("/items/{item_name}", response_model=Item)
async def read_item(item_name: str):item = fake_db.get(item_name)if not item:raise HTTPException(status_code=404, detail="Item not found")return Item(**item)

在这个示例中，我们创建了一个简单的“项目”管理API，包括获取所有项目、创建新项目和获取单个项目的功能。

我们还使用了依赖注入来获取所有项目，并添加了基本的错误处理逻辑。

如何使用 FastAPI 框架创建 RESTful API ？

FastAPI是一个现代、快速（高性能）的Web框架，用于构建API，它基于Python 3.6的类型提示功能，可以自动生成交互式API文档（使用Swagger UI或ReDoc），并且支持异步编程。二、创建第一个F…...

编程日记 2025/5/23 14:23:28

Java 继承

继承是所有 OOP 语言和 Java 语言不可缺少的组成部分。继承是 Java 面向对象编程技术的一块基石，是面向对象的三大特征之一，也是实现软件复用的重要手段，继承可以理解为一个对象从另一个对象获取属性的过程。如果类 A 是类 B 的父类&…...

编程日记 2025/5/18 1:31:19

嵌入式Linux QT+OpenCV基于人脸识别的考勤系统项目

此项目是基于人脸识别的考勤系统开发，包括如下模块： 1、人脸识别考勤系统GUI界面设计，包括： （1）Qt环境(window环境/linux环境) ； （2）Qt工程创建分析； &am…...

编程日记 2025/5/23 13:14:45

门户系统需要压测吗？以及门户系统如何压力测试？

一、门户系统为什么要进行压力测试？ 首先一点要明确一下，统一门户上线以后，将是所有应用系统的入口，对应门户稳定性要求较高，门户实现了统一入口和统一认证，系统宕机将影响其他系统使用。一般部署架构要求…...

编程日记 2025/5/23 13:07:58

Linux扩展——shell编程

前置：Linux基础及命令复习目录 shell概述Shell脚本入门案例 sh bash ./ . source 变量系统预定义变量 $HOME $PWD $SHELL等自定义变量 unset readonly补充：开启子Shell进程的常见方法 (...) $(...) ... <(...) >(...) 特殊变量 $n $# $* $ $&…...

编程日记 2025/5/23 12:23:12

golang, go sum文件保证下载的依赖模块是一致的

在 Go 编程语言中，go.sum 文件是 Go 模块管理的一部分，主要用于记录模块的校验信息（模块版本的校验和）。它的设计目标是确保模块的完整性和安全性，解决以下关键问题： 1. 确保模块版本的一致性 go.sum 文件…...

编程日记 2025/5/23 12:18:45

TANGO与LabVIEW控制系统集成

TANGO 是一个开源的设备控制和数据采集框架，主要用于管理实验室设备、自动化系统和工业设备。它为不同类型的硬件提供统一的控制接口，并支持设备之间的通信，广泛应用于粒子加速器、同步辐射光源、实验室自动化和工业控制等领域。 1. TANGO的核…...

编程日记 2025/5/23 12:27:11

【day14】异常处理与Object类深入解析

【day13】回顾在深入探讨异常处理与Object类之前，让我们回顾一下【day13】中的关键内容： 权限修饰符： public：最广的访问范围，任何地方都可以访问。protected：在同包和子类中可以访问。默认（无…...

编程日记 2025/5/23 13:31:52

云技术基础知识（二）：虚拟化与容器技术

内容预览 ≧∀≦ゞ虚拟化与容器技术虚拟化技术一、虚拟化的核心概念二、虚拟化的主要类型1. 服务器虚拟化2. 操作系统虚拟化（容器化）3. 网络虚拟化4. 存储虚拟化三、虚拟化的实现方法和工具1. 服务器虚拟化实现2. 操作系统虚拟化（容器化&am…...

编程日记 2025/5/23 12:24:34

【Java基础面试题033】Java泛型的作用是什么？

Java的基础语法可以看尚硅谷的这个PDF：尚硅谷JavaSE基础/《Java从入门到精通(JDK17版)》_尚硅谷电子书.pdf Autism_Btkrsr/Blog_md_to_pdf - 码云 - 开源中国 (gitee.com) 回答重点 Java泛型的作用是通过在编译时检查类型安全，允许程序员编写更通用和…...

编程日记 2025/5/23 12:11:17

Linux 基本使用和程序部署

1. Linux 环境搭建 1.1 环境搭建方式主要有 4 种： 直接安装在物理机上。但是Linux桌面使用起来非常不友好，所以不建议。[不推荐]。使用虚拟机软件，将Linux搭建在虚拟机上。但是由于当前的虚拟机软件(如VMWare之类的)存在一些bug&#xff…...

编程日记 2025/5/23 6:07:45

react中使用ResizeObserver来观察元素的size变化

在 React 中使用 ResizeObserver 来观察元素的大小变化，可以通过创建一个自定义 Hook 来封装 ResizeObserver 的逻辑，并在组件中使用这个 Hook。以下是一个完整的示例，展示了如何在 React 中使用 ResizeObserver 来观察元素的大小变化。自定…...

编程日记 2025/5/23 12:25:45

常见数据结构

1.数组 vector 2.链表 list 双向链表，不能通过下标找元素 3.栈 stack 4.队列 queue 优先队列priority_queue. 默认队头为最大值，可以用来任务调度，图算法，霍夫曼树 5.双端队列 deque 6.集合 set multiset s.begin() //返回…...

编程日记 2025/5/23 13:17:48

【服务器】linux服务器管理员查看用户使用内存情况

【服务器】linux服务器管理员查看用户使用硬盘内存情况 1、查看所有硬盘内存使用情况 df -h2、查看硬盘挂载目录下所有用户内存使用情况 du -sh /public/*3、查看某个用户所有文件夹占用硬盘内存情况 du -sh /public/zhangsan/*...

编程日记 2025/5/23 12:11:17

1. 冒泡排序 (1) 冒泡排序：每次从数组中找出最大值放在数值的后面去 public static void main(String[] args) {//冒泡排序int[] arr {5, 6 ,4, 9, 3, 1};for (int i 0; i < arr.length - 1; i) {for (int j 0; j < arr.length - i - 1; j) {if (arr[j] &…...

编程日记 2025/5/23 13:24:53

leetcode之hot100---240搜索二维矩阵II（C++）

思路一：通过遍历主对角线上元素判断查找方向主对角线遍历： 遍历主对角线上的每个元素（matrix[i][i]），其中 i 的范围是 [0, min(m, n) - 1]。如果目标值小于当前主对角线元素，说明目标值可能在当前元素的左…...

编程日记 2025/5/23 14:08:32

牛客--求小球落地5次后所经历的路程和第5次反弹的高度，称砝码

求小球落地5次后所经历的路程和第5次反弹的高度描述假设有一个小球从 hh 米高度自由落下，我们不考虑真实的物理模型，而是简洁的假定，该小球每次落地后会反弹回原高度的一半；再落下，再反弹；……。求小球…...

编程日记 2025/5/23 12:27:10

EasyPoi 使用$fe:模板语法生成Word动态行

1 Maven 依赖 <dependency><groupId>cn.afterturn</groupId><artifactId>easypoi-spring-boot-starter</artifactId><version>4.0.0</version> </dependency> 2 application.yml spring:main:allow-bean-definition-over…...

编程日记 2025/5/19 19:05:20

在 PowerShell 中优雅地显示 Python 虚拟环境

在使用 Python 进行开发时，虚拟环境管理是一个非常重要的部分。无论是使用 venv 还是 conda，我们都希望能够清晰地看到当前所处的虚拟环境。本文将介绍如何在 PowerShell 中配置提示符，使其能够优雅地显示不同类型的 Python 虚拟环境。问题…...

编程日记 2025/5/23 13:29:07

GUI07-学工具栏，懂MVC

MVC模式，是天底下编写GUI程序最为经典、实效的一种软件架构模式。当一个人学完菜单栏、开始学习工具栏时，就是他的一生中，最适合开始认识 MVC 模式的好时机之一。这节将安排您学习： Model-View-Controller 模式如何创建工具栏以及…...

编程日记 2025/5/18 16:52:25

免费线上签字小程序，开启便捷电子签名

虽如今数字化飞速发展的时代，但线上签名小程序的开发制作却并非易事。需要攻克诸多技术难题，例如确保签名的真实性与唯一性，防止签名被伪造或篡改。要精准地捕捉用户手写签名的笔迹特征，无论是笔画的粗细、轻重，还是…...

编程日记 2025/5/22 13:23:28

计算机的错误计算（一百八十九）

摘要用大模型计算 tan(12.345) . 自变量取弧度。结果保留10位有效数字。不同于前面两节的大模型，本节调用了新的两个大模型。然而，很遗憾，它们给出的答案似乎仍然是“匹配”出来的，不是计算出来的。当然，均是错误的。…...

编程日记 2025/5/22 2:40:14

HDR视频技术之十一：HEVCH.265 的 HDR 编码方案

前文我们对 HEVC 的 HDR 编码优化技术做了介绍，侧重编码性能的提升。本章主要阐述 HEVC 中 HDR/WCG 相关的整体编码方案， 包括不同应用场景下的 HEVC 扩展编码技术。 1 背景 HDR 信号一般意味着使用更多比特，一般的 HDR 信号倾向于使用 10…...

编程日记 2025/5/18 23:38:50

使用 AI 辅助开发一个开源 IP 信息查询工具：一

本文将分享如何借助当下流行的 AI 工具,一步步完成一个开源项目的开发。写在前面在写代码时，总是会遇到一些有趣的机缘巧合。前几天，我在翻看自己之前的开源项目时，又看到了 DDNS 相关的讨论。虽然在 2021 年我写过两篇相对详细的教程&am…...

编程日记 2025/5/18 2:02:51

『 Linux 』高级IO (一)

文章目录内容回顾及铺垫五种IO模型不同类型IO的区别非阻塞IOfcntl( ) 多路转接 - select( )select( ) 的基本使用 - SelectServer服务器内容回顾及铺垫在博客『 Linux 』基础IO/文件IO (万字)中介绍了对IO的认识; IO实际上为Input/Output,输入输出; 以网络协议栈的视角来看,…...

编程日记 2025/5/20 13:38:53

Cisco WebEx 数据平台：统一 Trino、Pinot、Iceberg 及 Kyuubi，探索 Apache Doris 在 Cisco 的改造实践

导读：Cisco WebEx 早期数据平台采用了多系统架构（包括 Trino、Pinot、Iceberg 、 Kyuubi 等），面临架构复杂、数据冗余存储、运维困难、资源利用率低、数据时效性差等问题。因此，引入 Apache Doris 替换了 Trino、Pinot…...

编程日记 2025/5/20 8:30:14

Java - 日志体系_Apache Commons Logging（JCL）日志接口库

文章目录官网1. 什么是JCL？2. JCL的主要特点3. JCL的核心组件4. JCL的实现机制5. SimpleLog 简介6. CodeExample 1 ： 默认日志实现 (JCL 1.3.2版本)Example 2 ： JCL (1.2版本） Log4J 【安全风险高，请勿使用】 7. 使用…...

编程日记 2025/5/23 10:30:26

Linux驱动开发 IIC I2C驱动编写APP访问EEPROM AT24C02

在嵌入式开发中，I2C（Inter-Integrated Circuit）是一种常用的串行通信协议，广泛应用于与外设（如 EEPROM、传感器、显示屏等）进行数据交换。AT24C02 是一种常见的 I2C EEPROM 存储器，它提供 2Kbit…...

编程日记 2025/5/18 15:03:12

盒子模型（外边距的设置）

用于页面中元素的合理布局所有的元素都可以有宽高所有元素都是一个矩形所有元素都可以看成一个盒子盒子包括外边距边框内边距元素内容外边距设置外边距的要素：top、bottom、left、right外边距的尺寸：合法的尺寸单位外边距语法：marign-方…...

编程日记 2025/5/20 0:01:24

买卖股票的最佳时机 IV - 困难

************* C topic：188. 买卖股票的最佳时机 IV - 力扣（LeetCode） ************* Stock angin: Still stocks. Intuitively, it feels hard. For once: class Solution { public:int maxProfit(vector<int>& prices) {in…...

编程日记 2025/5/22 12:49:25

ElasticSearch - 深入解析 Elasticsearch Composite Aggregation 的分页与去重机制

文章目录 Pre概述什么是 composite aggregation？基本结构after 参数的作用问题背景：传统分页的重复问题after 的设计理念响应示例 after 如何确保数据不重复核心机制Example步骤 1: 创建测试数据创建索引插入测试数据步骤 2: 查询第一页结果查询第一页返…...

编程日记 2025/5/22 16:47:42

HTML5 Web IndexedDB 数据库

IndexedDB 是一种基于浏览器的 NoSQL 数据库，用于在客户端持久化存储大量结构化数据。 IndexedDB 允许通过键值对存储复杂的数据对象（如对象、数组、文件等），并支持事务、索引、版本控制和复杂查询操作。 IndexedDB 是异步的&am…...

编程日记 2025/5/21 7:17:05

苏黎世联邦理工学院与加州大学伯克利分校推出MaxInfoRL：平衡内在与外在探索的全新强化学习框架

每周跟踪AI热点新闻动向和震撼发展想要探索生成式人工智能的前沿进展吗？订阅我们的简报，深入解析最新的技术突破、实际应用案例和未来的趋势。与全球数同行一同，从行业内部的深度分析和实用指南中受益。不要错过这个机会，成为AI领…...

编程日记 2025/5/21 5:27:55

读书笔记～管理修炼-缄默效应

缄默效应：学会正确批评下属员工明明犯了错误，却不及时告知你，总是拖到最后一刻无法弥补时才不得不承认出了问题——你遇到过这样的问题吗？ 这其实是缄默效应在发挥作用。在职场中，即使再扁平化的环境&…...

编程日记 2025/5/17 17:46:06

LabVIEW声音信号处理系统

开发了一种基于LabVIEW的声音信号处理系统，通过集成的信号采集与分析一体化解决方案，提升电子信息领域教学与研究的质量。系统利用LabVIEW图形化编程环境和硬件如USB数据采集卡及声音传感器，实现了从声音信号的采集到频谱分析的全过程。项目…...

编程日记 2025/5/22 20:01:53

2024.12.10——攻防世界Web_php_include

知识点：代码审计文件包含伪协议伪协议知识点补充： 在PHP中，伪协议（Pseudo Protocols）也被称为流包装器，这些伪协议以 php://开头，后面跟着一些参数，用于指定要执行的操作或需要…...

编程日记 2025/5/22 18:02:31

Linux shell脚本用于常见图片png、jpg、jpeg、webp、tiff格式批量转PDF文件

Linux Debian12基于ImageMagick图像处理工具编写shell脚本用于常见图片png、jpg、jpeg、webp、tiff格式批量转PDF文件，”多个图片分开生成多个PDF文件“或者“多个图片合并生成一个PDF文件” 在Linux系统中，使用ImageMagick可以图片格式转换&#xff0c…...

编程日记 2025/5/23 10:27:26

有没有检测吸烟的软件 ai视频检测分析厂区抽烟报警#Python

在现代厂区管理中，安全与规范是重中之重，而吸烟行为的管控则是其中关键一环。传统的禁烟管理方式往往依赖人工巡逻，效率低且存在监管死角，难以满足当下复杂多变的厂区环境需求。此时，AI视频检测技术应运而生&#xff0…...

编程日记 2025/5/22 23:03:30

LeetCode 每日一题 2024/12/16-2024/12/22

记录了初步解题思路以及本地实现代码；并不一定为最优也希望大家能一起探讨一起进步目录 12/16 1847. 最近的房间12/17 3291. 形成目标字符串需要的最少字符串数 I12/18 3292. 形成目标字符串需要的最少字符串数 II12/19 3285. 找到稳定山的下标12/20 3138. 同位…...

编程日记 2025/5/18 20:46:16

gitlab代码推送

点击这个√ 修改的文件全部选上填好提交的名称点击commit 选取提交的 gitlab 库点击Push...

编程日记 2025/5/15 13:20:37

小红书飞书素材库 | AI改写 | 无水印下载 | 多维表格 | 采集同步 | 影刀RPA

编程日记 2025/5/19 3:04:18

【计算机视觉基础CV-图像分类】02-入门详解图像分类、经典数据集、比赛与冠军图像模型演进史

前言图像分类（Image Classification）是计算机视觉（Computer Vision）中一项基础且核心的任务。简单来说，就是让计算机从给定的类别集合中，为一张输入图片分配一个正确的类别标签。这个过程听起来直观&…...

编程日记 2025/5/21 20:17:23

【机器学习】探索机器学习与人工智能：驱动未来创新的关键技术

探索机器学习与人工智能：驱动未来创新的关键技术前言：人工智能的核心技术深度学习：自然语言处理（NLP）：计算机视觉： 机器学习与人工智能的驱动创新医疗健康领域金融行业智能制造与工业互联网智慧…...

编程日记 2025/5/22 10:39:18

DS二叉树--基于数组存储的构建

题目描述任意二叉树可以根据完全二叉树性质保存在一个数组中。已知二叉树的数组存储，用程序构建该二叉树。提示：用递归方法或非递归都可以输入第一行输入一个整数t，表示有t个测试数据第二行起输入二叉树的数组存储结果，空…...

编程日记 2025/5/20 6:49:52

入侵他人电脑，实现远程控制（待补充）

待补充在获取他人无线网网络密码后，进一步的操作是实现入侵他人电脑，这一步需要获取对方的IP地址并需要制作自己的代码工具自动化的开启或者打开对方的远程访问权限。 1、获取IP地址（通过伪造的网页、伪造的Windows窗口、hook，信…...

编程日记 2025/5/20 10:26:16

STM32基于标准库如何查看时钟主频，100%简单

基于原有的工程写入两行代码，见下图 RCC_ClocksTypeDef get_rcc_clock; RCC_GetClocksFreq(&get_rcc_clock); 进入我们的仿真加入断点，然后在watch1观察变量值数据，然后在计算器计算就能得出，如上图。但是这样看的PAB1上…...

编程日记 2025/5/20 19:03:57

HarmonyOS NEXT 技术实践-基于意图框架服务实现智能分发

在智能设备的交互中，如何准确理解并及时响应用户需求，成为提升用户体验的关键。HarmonyOS Next 的意图框架服务（Intents Kit）为这一目标提供了强大的技术支持。本文将通过一个项目实现的示例，展示如何使用意图框架服务…...

编程日记 2025/5/21 17:53:15

[原创](Modern C++)现代C++的第三方库的导入方式: 例如Visual Studio 2022导入GSL 4.1.0

[简介] 常用网名: 猪头三出生日期: 1981.XX.XX 企鹅交流: 643439947 个人网站: 80x86汇编小站编程生涯: 2001年~至今[共23年] 职业生涯: 21年开发语言: C/C、80x86ASM、PHP、Perl、Objective-C、Object Pascal、C#、Python 开发工具: Visual Studio、Delphi、XCode、Eclipse…...

编程日记 2025/5/18 3:05:41

【jenkins插件】

1) 2) 3) 4) 5) 6) 参考: 知识库/运维/Jenkins/01-安装/13-插件.md zfoo/java-developer-document - 码云 - 开源中国...

编程日记 2025/4/20 22:49:27

springboot472基于web网上村委会业务办理系统(论文+源码)_kaic

摘要现代经济快节奏发展以及不断完善升级的信息化技术，让传统数据信息的管理升级为软件存储，归纳，集中处理数据信息的管理方式。本网上村委会业务办理系统就是在这样的大环境下诞生，其可以帮助管理者在短时间内处理完毕庞大的数…...

编程日记 2025/5/22 20:02:04