Python Web 开发：FastAPI 入门实战 —— HTTP 基础与 RESTful API 设计

news2024/12/1 11:35:31

Python Web 开发：FastAPI 入门实战 —— HTTP 基础与 RESTful API 设计

目录

  1. 🚀 HTTP 协议概述
  2. 🌐 HTTP 请求与响应的工作原理
  3. 🛠️ RESTful API 设计理念
  4. 🗂️ JSON 格式数据的传输与解析

1. 🚀 HTTP 协议概述

HTTP（HyperText Transfer Protocol）是现代互联网应用的基础协议，它定义了浏览器与服务器之间进行通信的规则。通过 HTTP 协议，客户端能够向服务器发送请求，服务器则根据请求内容返回响应数据。HTTP 协议的工作模型是请求-响应模式，客户端发出请求，服务器返回响应。

请求方法（Request Methods）

在 HTTP 协议中，请求方法决定了客户端希望对服务器上的资源执行何种操作。常见的请求方法包括：

  • GET：用于请求获取资源。GET 请求只用于获取数据，不会对服务器上的数据造成任何修改。

    @app.get("/items/{item_id}")
def read_item(item_id: int):
    return {"item_id": item_id}

  • POST：用于向服务器提交数据，通常用于创建资源。POST 请求会将数据发送到服务器，并让服务器根据这些数据进行处理。

    @app.post("/items/")
def create_item(item: Item):
    return {"name": item.name, "price": item.price}

  • PUT：用于更新资源。当客户端需要更新某个资源时，使用 PUT 请求来提交新数据。与 POST 请求不同，PUT 请求通常是幂等的，即多次提交相同数据的结果是一样的。

    @app.put("/items/{item_id}")
def update_item(item_id: int, item: Item):
    return {"item_id": item_id, "name": item.name, "price": item.price}

  • DELETE：用于删除资源。DELETE 请求通常是幂等的，即删除相同资源多次，结果不会发生变化。

    @app.delete("/items/{item_id}")
def delete_item(item_id: int):
    return {"message": f"Item {item_id} deleted"}

HTTP 状态码（Status Codes）

HTTP 状态码是服务器响应的核心部分，它指示了请求处理的结果。常见的状态码包括：

  • 2xx：成功类

    • 200 OK：请求成功，服务器返回所请求的资源或确认操作已完成。
    • 201 Created：请求成功且服务器创建了新的资源。

  • 3xx：重定向类

    • 301 Moved Permanently：请求的资源已永久迁移到新位置。
    • 302 Found：请求的资源暂时位于不同的位置。

  • 4xx：客户端错误类

    • 400 Bad Request：请求格式有误或缺少必要的参数。
    • 404 Not Found：请求的资源不存在。

  • 5xx：服务器错误类

    • 500 Internal Server Error：服务器发生了未预料的错误，导致请求无法完成。
    • 503 Service Unavailable：服务器暂时不可用，通常是由于服务器超载或正在进行维护。

在 FastAPI 中，你可以自定义 HTTP 状态码：

from fastapi import HTTPException

@app.get("/items/{item_id}")
def read_item(item_id: int):
    if item_id == 42:
        raise HTTPException(status_code=404, detail="Item not found")
    return {"item_id": item_id}

HTTP 头部（Headers）

HTTP 请求和响应包含了许多有用的头部信息，如请求的内容类型、响应的格式、缓存策略等。常见的头部包括：

  • Content-Type：指定请求或响应的内容类型。例如，application/json 表示发送的内容是 JSON 格式。
  • Authorization：用于身份验证，常见的如 Bearer Token。
  • User-Agent：指定发起请求的客户端软件（如浏览器或应用）。

在 FastAPI 中，头部可以通过参数注入：

from fastapi import Header

@app.get("/header/")
def read_header(user_agent: str = Header(...)):
    return {"User-Agent": user_agent}

2. 🌐 HTTP 请求与响应的工作原理

HTTP 协议的工作原理基于客户端和服务器之间的请求-响应模型。当客户端向服务器发出请求时，服务器解析请求并返回响应。整个过程分为以下几个步骤：

客户端发起请求

客户端发起 HTTP 请求时，包含以下主要信息：

  • 请求行：包括 HTTP 方法（如 GET、POST）、请求的资源路径和协议版本。例如：GET /items/123 HTTP/1.1。
  • 请求头：包含请求的元数据，如 Content-Type、Authorization 等。
  • 请求体（可选）：在 POST、PUT 等方法中，请求体包含了客户端发送给服务器的数据，如 JSON 格式的对象。

在 FastAPI 中，HTTP 请求通常通过 HTTP 方法装饰器定义，例如 @app.get("/path")。

服务器处理请求

服务器接收到 HTTP 请求后，会根据请求的 URL 路径、方法及参数进行处理。FastAPI 会根据请求的 URL 路径和 HTTP 方法匹配相应的视图函数。当请求包含参数时，FastAPI 会自动将这些参数提取并传递给函数。例如：

@app.get("/items/{item_id}")
def read_item(item_id: int):
    return {"item_id": item_id}

此时，item_id 就是从 URL 路径中提取的参数。

服务器返回响应

服务器根据处理结果构建一个 HTTP 响应，包含响应行、响应头和响应体。响应体通常是请求数据的结果，格式可能是 JSON、HTML、纯文本等。

在 FastAPI 中，响应数据通常是 JSON 格式：

from fastapi import FastAPI

app = FastAPI()

@app.get("/items/{item_id}")
def read_item(item_id: int):
    return {"item_id": item_id}

当客户端接收到响应时，它将解析响应头和响应体，并根据需要进行处理。

3. 🛠️ RESTful API 设计理念

REST（Representational State Transfer）是一种基于 HTTP 协议的架构风格，用于设计可扩展和可维护的 API。RESTful API 是遵循 REST 架构风格设计的 API，它利用 HTTP 方法来定义操作，并通过 URL 进行资源标识。

资源的定义

在 RESTful API 中，一切内容都被视为资源。资源可以是数据实体，如用户、商品、订单等，也可以是服务或操作。每个资源都应该具有唯一的标识符，通常是 URL 路径。

例如，在一个电商平台中，可以定义以下资源：

  • 用户资源：/users/{user_id}
  • 商品资源：/products/{product_id}

资源的操作

RESTful API 通过 HTTP 方法对资源进行操作。常见的操作包括：

  • GET：用于查询资源。通过 GET 请求可以获取某个资源的详细信息，或者获取资源的列表。
  • POST：用于创建资源。通过 POST 请求，可以将新资源提交到服务器，并创建新的数据实体。
  • PUT：用于更新资源。通过 PUT 请求，可以修改现有资源的数据。
  • DELETE：用于删除资源。通过 DELETE 请求，可以删除某个资源。

RESTful URL 设计原则

RESTful API 的 URL 设计应该遵循以下原则：

  • 使用名词表示资源，而不是动词。比如，/items 表示所有的商品资源，而不是 /getItems。
  • 使用层级结构来表示资源之间的关系。例如，/users/{user_id}/orders 表示某个用户的订单。
@app.get("/users/{user_id}/orders")
def get_orders(user_id: int):
    return {"user_id": user_id, "orders": orders}

4. 🗂️ JSON 格式数据的传输与解析

JSON（JavaScript Object Notation）是一种轻量级的数据交换格式，易于人类阅读和编写，同时也易于机器解析和生成。它在 Web 开发中广泛应用，尤其是在客户端与服务器之间的数据传输中。

JSON 数据格式

JSON 数据格式由键值对组成，键是字符串，值可以是字符串、数字、布尔值、数组、对象或 null。例如：

{
  "name": "John Doe",
  "age": 30,
  "is_student": false,
  "courses": ["Math", "Science"]
}

在 FastAPI 中，客户端和服务器通过 JSON 格式进行数据交互。FastAPI 会自动处理 JSON 的解析和生成，客户端只需要发送符合 JSON 格式的数据即可。

FastAPI 中的 JSON 解析

FastAPI 使用 Pydantic 模型来验证和解析 JSON 数据。在请求

体中，FastAPI 会自动将 JSON 数据转换为 Python 对象，并根据定义的 Pydantic 模型进行验证。例如：

from pydantic import BaseModel

class Item(BaseModel):
    name: str
    price: float

@app.post("/items/")
def create_item(item: Item):
    return {"name": item.name, "price": item.price}

在客户端发送一个 JSON 请求时：

{
  "name": "Laptop",
  "price": 1000.0
}

FastAPI 会自动解析这个 JSON 请求并将其转换为 Item 对象。

JSON 响应

FastAPI 在返回响应时也会使用 JSON 格式。默认情况下，FastAPI 会将返回的数据自动转换为 JSON 格式：

@app.get("/items/{item_id}")
def get_item(item_id: int):
    return {"item_id": item_id, "name": "Laptop", "price": 1000.0}

客户端接收到的响应将会是：

{
  "item_id": 1,
  "name": "Laptop",
  "price": 1000.0
}

以上内容涵盖了 HTTP 协议基础、请求与响应的工作原理、RESTful API 设计理念以及 JSON 格式的数据传输与解析，为 FastAPI 入门打下了坚实的基础。通过这些知识，可以更好地理解 FastAPI 的工作机制，进而高效地构建 Web 应用。

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

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

相关文章

智能桥梁安全运行监测系统守护桥梁安全卫士

智能桥梁安全运行监测系统守护桥梁安全卫士

一、方案背景 桥梁作为交通基础设施中不可或缺的重要组成部分，其安全稳定的运行直接关联到广大人民群众的生命财产安全以及整个社会的稳定与和谐。桥梁不仅是连接两地的通道，更是经济发展和社会进步的重要纽带。为了确保桥梁的安全运行，桥梁安…
阅读更多...
网络原理-初识

网络原理-初识

1.网络的发展历程 独立模式 独立模式：计算机之间相互独立。 每个终端A、B、C各自持有客户端数据 网络互连 随着时代的发展，越来越需要计算机之间互相通信，共享软件和数据，即可以多个计算机协调工作来完成业务，就有…
阅读更多...
房屋结构安全监测系统守护房屋安全卫士

房屋结构安全监测系统守护房屋安全卫士

一、系统背景 随着时间的流逝，建筑物的主体结构、设备设施等会因为自然老化、材料疲劳、使用环境的变化以及维护不当等各种因素的影响，逐渐出现性能下降甚至安全隐患。因此，进行房屋安全监测显得尤为重要。房屋结构安全是指建筑物的结构体系在…
阅读更多...
排序算法之选择排序堆排序

排序算法之选择排序堆排序

算法时间复杂度辅助空间复杂度稳定性选择排序O(N^2)O(1)不稳定堆排序O(NlogN)O(1)不稳定 1.选择排序 这应该算是最简单的排序算法了，每次在右边无序区里选最小值，没有无序区时，就宣告排序完毕 比如有一个数组：[2,3,2,6,5,1,4]排…
阅读更多...
从0开始linux（39）——线程（2）线程控制

从0开始linux（39）——线程（2）线程控制

欢迎来到博主的专栏：从0开始linux 博主ID：代码小豪 文章目录 线程创建线程标识符线程参数多线程竞争资源 回收线程detach 线程退出pthread_cancel 线程创建 线程创建的函数为pthread_create。该函数是包含在posix线程库当中，posix线程是C语言…
阅读更多...
28.100ASK_T113-PRO Linux+QT 显示一张照片

28.100ASK_T113-PRO Linux+QT 显示一张照片

1.添加资源文件 2. 主要代码 #include "mainwindow.h" #include "ui_mainwindow.h" #include <QImage> #include <QPixmap>MainWindow::MainWindow(QWidget *parent) :QMainWindow(parent),ui(new Ui::MainWindow) {ui->setupUi(this);QIm…
阅读更多...
不用下载安装的线上3D编辑器，支持哪些功能？

不用下载安装的线上3D编辑器，支持哪些功能？

线上3D编辑器&#xff0c;不用下载软件&#xff0c;直接通过浏览器打开51建模网&#xff0c;上传模型即可进入编辑器&#xff0c;不仅支持对3D模型进行细致的效果配置&#xff0c;如光源设置、背景定制、材质调节等&#xff0c;还具备爆炸效果、热点动画、部件替换等高级交互功…
阅读更多...
C语言——指针初阶（三）

C语言——指针初阶（三）

目录 一.指针-指针 代码1&#xff1a; 运行结果&#xff1a; 代码2&#xff1a; 运行结果&#xff1a; 代码3&#xff1a; 运行结果&#xff1a; 二.指针数组 例&#xff1a; 往期回顾 一.指针-指针 指针减去指针的前提&#xff1a;两个指针指向同一块空间。 指针减去指针…
阅读更多...
vue3项目创建方式记录

vue3项目创建方式记录

目录 创建vue3常用的方式有三种&#xff1a;一.使用vue cli创建二.使用vite创建三.使用vue3官方推荐创建方式&#xff08;create-vue&#xff09; 创建vue3常用的方式有三种&#xff1a; 一.使用vue cli创建 vue create 项目名二.使用vite创建 vite是下一代前端开发与构建工…
阅读更多...
基于特征子空间的高维异常检测：一种高效且可解释的方法

基于特征子空间的高维异常检测：一种高效且可解释的方法

本文将重点探讨一种替代传统单一检测器的方法&#xff1a;不是采用单一检测器分析数据集的所有特征&#xff0c;而是构建多个专注于特征子集(即子空间)的检测器系统。 在表格数据的异常检测实践中&#xff0c;我们的目标是识别数据中最为异常的记录&#xff0c;这种异常性可以…
阅读更多...
MySQL —— MySQL 程序

MySQL —— MySQL 程序

目录 前言 一、MySQL 程序简介 二、mysqld -- MySQL 服务器 三、mysql -- MySQL 客户端 1. mysql 客户端简介 2. mysql 客户端选项 &#xff08;1&#xff09;指定选项的方式 &#xff08;2&#xff09;mysql 客户端命令常用选项 &#xff08;3&#xff09;在命令行中使…
阅读更多...
Flink CDC 使用实践以及遇到的问题

Flink CDC 使用实践以及遇到的问题

背景 最近公司在做一些业务上的架构调整&#xff0c;有一部分是数据从mysql采集到Starrocks&#xff0c;之前的一套方法是走 debezium 到 puslar 到 starrocks,这一套下来比较需要配置很多东西&#xff0c;而且出现问题以后&#xff0c;需要修改很多配置&#xff0c;而且现阶段…
阅读更多...
数据链路层（三）--点对点通信协议PPP

数据链路层（三）--点对点通信协议PPP

PPP协议叫做点对点协议&#xff0c;是目前使用的最广泛的数据链路层协议。 1 PPP协议的特点 用户通常需要连接到某个ISP才能接入互联网&#xff0c;PPP协议就是用户计算机和ISP进行通信所使用的数据链路层协议。 1.1 PPP协议应满足的需求 &#xff08;1&#xff09;简单&…
阅读更多...
C语言 分支语句(if)

C语言 分支语句(if)

分支语句(if) if语句形式一 适用只有一个分支判断 if(表达式1) //如果 { 语句块1 } if语句形式二 适用有两个分支判断 if(表达式1) //如果 { 语句块1 } else //否则 { 语句块2 } 例:求方程的根 if语句形式三 适用多分支判断 if(表达式1) //多分支 { 语句块1 } else if(表达…
阅读更多...
如何将WSL的虚拟机安装到任意目录中

如何将WSL的虚拟机安装到任意目录中

目录 引言 下载安装包 解压安装包 手工安装 结语 引言 WSL默认是将虚拟机安装在C盘的用户目录下&#xff0c;如果长时间使用Windows后&#xff0c;可能C盘的空间就会非常吃紧&#xff0c;所以非常希望把虚拟机安装到C盘以外的目录中。本文就介绍一下相关的工作。 这里只讨…
阅读更多...
一款.NET开源的Windows资源管理器标签页工具

一款.NET开源的Windows资源管理器标签页工具

前言 今天大姚给大家分享一款基于.NET开发的可以让你在Windows资源管理器中使用Tab多标签功能的小工具&#xff1a;QTTabBar。 工具介绍 QTTabBar是一款基于.NET开发的可以让你在Windows资源管理器中使用Tab多标签功能的小工具。从此以后工作时不再遍布文件夹窗口&#xff0c…
阅读更多...
传输控制协议（TCP）

传输控制协议（TCP）

传输控制协议是Internet一个重要的传输层协议。TCP提供面向连接、可靠、有序、字节流传输服务。 1、TCP报文段结构 注&#xff1a;TCP默认采用累积确认机制。 2、三次握手、四次挥手 &#xff08;1&#xff09;当客户向服务器发送完最后一个数据段后&#xff0c;发送一个FIN段…
阅读更多...
c++哈希表（原理、实现、开放寻址法）适合新手

c++哈希表（原理、实现、开放寻址法）适合新手

c系列哈希的原理及实现&#xff08;上&#xff09; 文章目录 c系列哈希的原理及实现&#xff08;上&#xff09;前言一、哈希的概念二、哈希冲突三、哈希冲突解决3.1、开放寻址法3.2、删除操作3.3、负载因子四、代码实现 总结 前言 红黑树平衡树和哈希有不同的用途。 红黑树、…
阅读更多...
服务器数据恢复—raid6阵列硬盘被误重组为raid5阵列的数据恢复案例

服务器数据恢复—raid6阵列硬盘被误重组为raid5阵列的数据恢复案例

服务器存储数据恢复环境&#xff1a; 存储中有一组由12块硬盘组建的RAID6阵列&#xff0c;上层linux操作系统EXT3文件系统&#xff0c;该存储划分3个LUN。 服务器存储故障&分析&#xff1a; 存储中RAID6阵列不可用。为了抢救数据&#xff0c;运维人员使用原始RAID中的部分…
阅读更多...
Python酷库之旅-第三方库Pandas(250)

Python酷库之旅-第三方库Pandas(250)

目录 一、用法精讲 1181、pandas.tseries.offsets.BusinessMonthEnd.is_on_offset方法 1181-1、语法 1181-2、参数 1181-3、功能 1181-4、返回值 1181-5、说明 1181-6、用法 1181-6-1、数据准备 1181-6-2、代码示例 1181-6-3、结果输出 1182、pandas.tseries.offse…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023