fastapi教程（三）：处理请求

原创 已于 2024-07-23 22:36:52 修改 · 1.9k 阅读 · 26
标签
#fastapi
于 2024-07-22 20:59:44 首次发布

环境：

  • Python 3.11
  • Windows 10
  • fastapi 0.68.0

一，路由与路由处理函数

几步就能用 fastapi 提供 api :

# main.py
from fastapi import FastAPI

app = FastAPI()


@app.get("/")
async def root():
    return {
   
   "message": "Hello World"}


@app.get("/hello/{name}")
async def say_hello(name: str):
    return {
   
   "message": f"Hello {
     
     name}"}


if '__main__' == __name__:
    import uvicorn
    uvicorn.run(app,port=8088)

运行项目，输出：

I:\Python\Web\FastAPI\fastApiProject1\.venv\Scripts\python.exe I:\Python\Web\FastAPI\fastApiProject1\main.py 
INFO:     Started server process [32796]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://127.0.0.1:8088 (Press CTRL+C to quit)

1，导入 FastAPI：

from fastapi import FastAPI

2，创建一个 FastAPI 实例：

from fastapi import FastAPI

app = FastAPI()

3，创建一个路由：

  • 请求路径为 /
  • 接收 get 请求
from fastapi import FastAPI

app = FastAPI()

@app.get("/")

通常使用：
● POST：创建数据。使用 @app.post()
● GET：读取数据。使用 @app.get()
● PUT：更新数据。使用 @app.put()
● DELETE：删除数据。使用 @app.delete()

4，定义路由处理函数：

from fastapi import FastAPI

app = FastAPI()


@app.get("/")
async def root():
    return {
   
   "message": "Hello World"}

5，运行开发服务器：

$ uvicorn main:my_awesome_api --reload

浏览器访问 http://127.0.0.1:8080/ 可以获得：
在这里插入图片描述

浏览器访问 http://127.0.0.1:8088/docs 可以获得：
在这里插入图片描述

二，请求参数与表单

（一）路径参数

1，简单路径参数

from fastapi import FastAPI

app = FastAPI()

@app.get("/hello/{name}")
async def say_hello(name):
    return {
   
   "message": f"Hello {
     
     name}"}
  • 路径参数有是必须的。

访问 http://127.0.0.1:8088/hello/Jack 可以获得：
在这里插入图片描述
当路径参数缺失时，访问 http://127.0.0.1:8088/hello 将报错，因为这个残缺的路由根本不存在：
在这里插入图片描述

查看API：
在这里插入图片描述

  • API 页面就提示这个 name 参数是必须的。

2，带类型的路径参数

可在路径参数后面加上 : 类型。

  • 如果不指定类型，将默认使用 str 类型。
from fastapi import FastAPI

app = FastAPI()

@app.get("/books/{book_id}")
async def say_hello(book_id: int):
    return {
   
   "message": f"book id {
     
     book_id}"}

访问 http://127.0.0.1:8088/books/123 可以获得：
在这里插入图片描述
查看API：
在这里插入图片描述

使用带类型的路径参数的最大好处就是使用 fastapi 提供的类型验证机制。

对于上面的程序，如果访问 http://127.0.0.1:8088/books/“123” 将得到一个报错：

{
   
   
    "detail": [
        {
   
   
            "type": "int_parsing",
            "loc": [
                "path",
                "book_id"
            ],
            "msg": "Input should be a valid integer, unable to parse string as an integer",
            "input": "\"123\"",
            "url": "https://errors.pydantic.dev/2.4/v/int_parsing"
        }
    ]
}
  • 这是因为 fastapi 在对 “123” 进行类型验证时，无法将它识别为 int 类型的数据，所以在报错中明确说明了原因。

3，路由访问顺序

由于 fastapi 会按照路由注册顺序来访问路由，所以可能会出现路由访问被截胡的情况：

from fastapi import FastAPI

app = FastAPI()


@app.get("/user/me")
async def read_user_me():
    return {
   
   "user_id": "the current user"}


@app.get("/user/{user_id}")
async def read_user(user_id: str):
    return {
   
   "user_id": user_id}

一般来说，我们需要访问类似于 http://127.0.0.1:8088/user/some-id 这样的链接来获取具体信息。

但如果恰好有个 user_id 就是 me，即访问 http://127.0.0.1:8088/user/me 时就会得到一个期待之外的信息。

所以尤其需要注意路由的注册顺序，尽量将通用的、一般的路由放在前面。

4，使用枚举类型参数

解释一下枚举：是为变量提供一组命名的整数常量的方式。在Python中可以通过enum模块实现枚举。

枚举类型的好处是可以将一组常量的值集中在一个类中，这样可以提高代码的可读性和可维护性。

from enum import Enum

class Color(Enum):
    RED = 1
    GREEN = 2
    BLUE = 3

print(Color.RED) 			# -> Color.RED
print(Color.RED.value) 		# -> 1
print(Color(1)) 			# -> Color.RED
print(Color['RED']) 		# -> Color.RED

fastapi 允许使用枚举来对路径参数中接收到的数值进行验证：

from enum import Enum

from fastapi import FastAPI

app = FastAPI()


class ModelName(str, Enum):
    RED = 1
    GREEN = 2
    BLUE = 3


@app.get("/models/{model_name}")
async def get_model(model_name: ModelName):
    if model_name == ModelName.RED:
        return {
   
   "model_name": model_name, "message": "RED"}
    if model_name == ModelName.GREEN:
        return {
   
   "model_name": model_name, "message": "GREEN"}
    if model_name == ModelName.BLUE:
        return {
   
   "model_name": model_name, "message": "BLUE"}

    return {
   
   "model_name": model_name, "message": "UNKNOWN"}


if '__main__' == __name__:
    import uvicorn
    uvicorn.run(app,port=8088)

访问：
● http://127.0.0.1:8088/models/1
● http://127.0.0.1:8088/models/2
● http://127.0.0.1:8088/models/3

5，在路径参数中包含路径

有一种常见的需求是，通过一个路由来访问服务器上的文件，例如 /files/{file_path}，通常来说这个文件存放在服务器上一个具体的文件路径下，例如 home/johndoe/myfile.txt，所以这个完整的路由就是 /files/home/johndoe/myfile.txt，这需要使用路径转换器:path 来实现。

from fastapi import FastAPI

app = FastAPI()


@app.get("/files/{file_path:path}")
async def read_file(file_path: str):
    return {
   
   "file_path": file_path}

这个 file_path 可以是文件的绝对路径，也可以是相对于路由处理函数所在文件的相对路径。
例如我们的项目结构是：
在这里插入图片描述
相对路径：
在这里插入图片描述

绝对路径：
在这里插入图片描述

6，路径参数和数值校验

可以使用 Path 为路径参数声明类型校验和元数据。

提示： 先看“查询参数和字符串校验”再回来看。
能够以与“查询参数和字符串校验”相同的方式使用 Query、Path（以及其他你还没见过的类）声明元数据和字符串校验。

（二）查询参数

路由中的路径参数和查询参数都是用于传递参数给路由处理函数的方法，主要的区别是:

  1. 路径参数是通过路由路径传递的参数,查询参数是通过请求URL的查询字符串传递的参数。
  2. 路径参数需要在路由中声明和定义,查询参数可以不需要声明。
  3. 路径参数可以出现在路由路径的任何位置,查询参数只能出现在路由路径的后面。
  4. . 路径参数通常用于必要的参数,查询参数用于可选的参数。

用场景:

  1. 路径参数用于标识一个资源或路由,如:/user/:id 用于标识用户的id。
  2. 路径参数用于 Required 参数,查询参数用于 Optional 参数。
  3. 路径参数适合少量参数,查询参数可以传递大量参数。
  4. 路径参数更美观,查询参数更灵活。

所以一般来说，必要的和结构化的参数用路径参数，可选的和非结构化的参数用查询参数。但也要根据实际场景来决定使用哪种参数。

1，标准查询参数

查询参数通过 ? 拼接在路由最后面，例如 http://127.0.0.1/path?query_param=x。
多个查询参数用 & 分割，例如 http://127.0.0.1/path?query_param1=x&query_param2=y。

from fastapi import FastAPI

app = FastAPI()

data = [
    {
   
   'name': 'John', 'age': 25},
    {
   
   'name': 'Jane', 'age': 24},
    {
   
   'name': 'Jack', 'age': 26},
]


# http://127.0.0.1:8088/users/?page_num=2&page_size=1
@app.get('/users/')
def get_users(page_num: int = 1, page_size: int = 1):
    start = (page_num - 1) * page_size
    end = start + page_size
    return data[start:end]

这里在路径操作函数中定义了两个查询参数 page_num 和 page_size，分别表示页码和每页的数据量，数据类型都是 int，分别默认值为 1 和 1。

访问 http://127.0.0.1:8088/users/?page_num=2&page_size=1 获得：
在这里插入图片描述

查看 API：
在这里插入图片描述

需要将没有「默认值」的参数放在带有「默认值」的参数之前，否则会报错。

路由处理函数是这样处理查询参数的默认值的：

  • 当 URL 中未指定任何查询参数时，所有查询参数都将使用默认值。
  • 当 URL 中指定了部分查询参数时，未指定的查询参数将使用默认值。
  • 当 URL 中指定了所有查询参数时，所有查询参数都将使用指定的值。

2，可选查询参数

可选查询参数是指被定义后可被使用，也可不被使用的查询参数，且默认值只能为 None 的查询参数。

fastapi 中的可选查询参数需要在路由处理函数中使用 Optional 类型：

import uvicorn
from typing import Optional

from fastapi import FastAPI

app = FastAPI()

data = [
    {
   
   'name': 'John', 'age': 25},
    {
   
   'name': 'Jane', 'age': 24},
    {
   
   'name': 'Jack', 'age': 26},
]


@app.get('/users/{user_name}')
def get_user(
        user_name: str,
        age: Optional[str] = None
):
    if age:
        return {
   
   'user_name': user_name,
最低0.47元/天 解锁文章
FastAPI Post 请求
11-22 1805
app.post("/android/notification", summary="通知", description=f"通知接口", tags=["android"])return {"status": true, "data": {}, "msg": "成功"}file_content = await file.read() # 读取文件。
fastapi——简单快速入门
m0_55212788的博客
09-08 4420
fastapi print("\033[31m5. --- ORM模型: 从类创建符合的ORM对象模型 ---\033[Om")#显示彩色内容 fastapi是高性能的web框架。他的主要特点是： 快速编码 减少人为bug 直观 简易 具有交互式文档 基于API的开放标准（并与之完全兼容）：OpenAPI（以前称为Swagger）和JSON Schema。 1.1fastapi的安装 一、fastapi的安装 pip install fastapi 当然你可以使用国内阿里云镜像源进行安装，会快很多，
Python - FastAPI 实现 get、post 请求
BITDDD小栈
09-19 7461
使用 FastAPI 搭建 Server Demo 与 get、post 操作示例。
FastAPI 接口全攻略：GET/POST/PUT/DELETE 实战｜ 后端服务篇
最新发布
中后台前端工程师，专注技术本质，用通俗语言讲清硬核知识点，持续输出成长干货。
04-10 1023
本文面向前端转 AI 应用开发工程师，以 FastAPI+Pydantic+Uvicorn 为核心，从零搭建标准 RESTful 风格 CRUD 接口服务，详解 GET/POST/PUT/DELETE 语义规范、参数校验、状态码设计与自动文档生成，结合可直接运行的实战代码，避开接口语义混乱、校验缺失、幂等忽视等高频坑点，快速掌握将模型能力封装为规范 HTTP 接口的工程写法，夯实 AI 应用后端服务基础。
5.FastAPI显式声明参数
chenhaiy的博客
01-12 1404
5.FastAPI显式声明参数 FastAPI允许显式声明参数属于查询参数、路径参数或者请求体；同时还可以为参数声明默认值、额外的信息及校验；也允许显式声明可选参数； 5.1可选参数 可选参数的显式声明使用 typing. Optional来声明；代码如下： # coding: utf-8 ​ from typing import Optional from fastapi import FastAPI ​ app = FastAPI() ​ @app.get(path='/add/{vara}/
fastapi入门三post请求
热门推荐
舌尖上的蛋炒饭的博客
12-07 5万+
fastapi入门三post请求 post请求一般的请求体都是json格式的 在这里我们需要引入一个新的包，下面这个包就是用来定义入参的消息体的 pip3 install pydantic 简单的post请求 请求地址 http://127.0.0.1:8100/fastapi/ 请求体（均使用默认值，所以请求体为空） { } 代码 """ @File : fastapiOne.py @Desciption： """ import uvicorn from fastapi import F
FastAPI系列教程05：FastAPI请求（request）
GeekABC
10-28 6024
Request是FastAPI针对客户端请求信息提供的访问接口，因此要更简便地处理请求信息可以使用Request，而要更个性话地处理请求信息可以直接访问ASGI scope和receive channel。
FastAPI 请求详解：全面掌握各种请求类型处理
这里是 「Py玩家的栈与星辰」，专注分享Python开发、DevOps实践、云原生技术与系统安全领域的深度干货。
08-19 1110
本文系统介绍FastAPI处理HTTP请求的核心方法，涵盖路径参数、查询参数、请求体、文件上传等常用功能。FastAPI基于Python类型提示和Pydantic模型，提供自动类型转换、验证和API文档生成。文章详细讲解RESTful路由设计原则、参数验证规则及最佳实践，包括如何混合使用路径/查询/请求体参数、处理文件上传和表单数据、读取Header/Cookie等。同时强调异常处理和安全性考量，如限制文件大小、统一错误响应格式等。通过合理组合这些机制，开发者可以构建类型安全、结构清晰的现代Web API。
【Python系列】FastApi发送Post请求
CSDN站内信: https://i.csdn.net/#/msg/chat/qyj19920704
09-05 2万+
FastAPI 是一个现代、快速（高性能）的 Web 框架，用于构建 API，它基于 Python 3.6 及以上版本。在 FastAPI 中发送 POST 请求，通常是指创建一个接口来接收客户端发送的 POST 请求。
FASTAPI 07-POST请求
lzq599220的博客
03-15 3066
本章介绍了如何在FastAPI框架中处理POST请求以及如何结合路径参数来接收并处理JSON格式的请求体，FastAPI利用Python类型提示和Pydantic模型，简化了POST请求中JSON数据的接收和处理过程，同时也提供了强大的数据验证和API文档自动生成功能。通过结合路径参数与请求体，开发者能够轻松地设计和实现复杂接口；
4. fastApi请求体详解
Jesse_Kyrie的博客
02-21 3916
fastApi请求体数据处理详解
fastapi入门一简单的get请求
舌尖上的蛋炒饭的博客
12-01 2109
fastapi入门一简单的get请求 依赖包准备 pip3 install uvicorn pip3 install fastapi get请求 """ @File : fastapiOne.py @Desciption： """ import uvicorn from fastapi import FastAPI app = FastAPI() # app = FastAPI() 用于实例化 FastAPI类，通常app这个变量会设置成全局的，至少在当前模块作用域有效。 @app.get
FASTAPI系列 06-Get请求的多参数查询
lzq599220的博客
03-14 2220
我将介绍get请求的多参数查询，包含查询参数列表，具备默认值的参数列表，别名参数；通过此章内容你会了解到在get请求中使用list传入多参数，并给参数赋予默认值；在有需要时，给使用alias给参数别名， 当需要描述更多时， 在Query中添加title以及description参数。
FASTAPI系列 04-GET请求 params参数
lzq599220的博客
03-12 1855
get请求的参数在url后面携带，通常称做query params主要介绍了如何在FastAPI框架中处理和定义GET请求的查询参数（query params），以及如何结合分页和多路径参数进行操作。首先，通过定义一个Pydantic模型来结构化查询参数，并将其作为FastAPI路由处理函数的输入参数，能够方便地对查询参数进行验证和类型转换。
【4.0】Fastapi简单使用
Chimengmeng的博客
10-01 272
【一】Fastapi引入 【1】构建基础的fastapi项目 from fastapi import FastAPI from typing import Optional from pydantic import BaseModel # 创建 fastapi 对象 app = FastAPI() # 定义模型表 class CityInfo(BaseModel): # 省份 ...
FastAPI中，@app.post()、@app.put()、@app.delete() 有什么区别
qq_39219148的博客
09-20 5674
这些装饰器允许您将不同的 HTTP 请求方法映射到相应的处理函数上，以便在 FastAPI 应用中定义不同的路由。装饰器定义了一个处理 DELETE 请求的路由。根据不同的 HTTP 请求方法，这些路由会执行相应的逻辑来处理客户端的请求。装饰器定义了一个处理 POST 请求的路由，装饰器定义了一个处理 PUT 请求的路由，在 FastAPI 中，
1 fastAPI请求方式
wujianyouhun的专栏
02-06 1107
FastAPI 支持多种 HTTP 请求方式（也称为 HTTP 动作或方法），这些方法通常对应 RESTful API 中的基本操作：创建、获取、更新和删除（即 CRUD 操作）。下面我将介绍 FastAPI 如何处理这些请求方式。
fastapi学习（二）：路径参数获取与GET、POST参数获取
呆萌的代Ma
03-10 8264
文章目录路径参数获取Get参数获取Post参数获取完整代码 Fastapi中是用模板来匹配URL： 路径参数获取：获取自定义的构造URL时的参数 Get参数获取：获取一个URL后面带的?param1=1&param2=2这种参数 Post参数获取：获取Post时的参数，因为Post是加密的，因此更加安全，但有额外开销 路径参数获取 比如： http://127.0.0.1:5555/name=aa/age=324 http://127.0.0.1:5555/name=bb/age=423 htt
FastAPI学习-3.get 请求 query params 查询参数
qq_27371025的博客
03-13 2289
前言 get 请求的参数在url 后面带着，一般叫query params 查询参数 查询参数 声明不属于路径参数的其他函数参数时，它们将被自动解释为"查询字符串"参数 from fastapi import FastAPI app = FastAPI() fake_items_db = [{"item_name": "Foo"}, {"item_name": "Bar"}, {"item_name": "Baz"}] @app.get("/items/") async def read_item(
fastapi 入门系列
qq_38195610的博客
05-09 9145
FastAPI是一个现代、快速（高性能）的Web框架，用于构建API。它基于Python 3.7+的类型提示（type hints）和异步编程（asyncio）能力，使得代码易于编写、阅读和维护。FastAPI具有自动交互式文档（基于OpenAPI规范和JSON Schema）、数据验证、依赖注入（Dependency Injection）等功能，这些功能使得API的开发速度更快、更可靠。FastAPI还支持WebSocket和GraphQL，可以轻松地扩展到更复杂的应用场景。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值