FastApi中的常见请求类型

news2024/10/6 10:35:25

FastApi中的常见请求类型

FastAPI

后端开发语言中，我钟情于node，高效的异步处理真是让我眼前一亮，同时，简单易懂的语法也让我非常倾心

但是但是，因为考虑要写一个深度学习算法的后端接口，所以不得不选用python作为后端进行开发，并不是我不喜欢Python，相反，Python作为我的第一语言，我同样非常喜欢，只不过我更喜欢用它来做数据分析

关于Python的后端框架，在Django和fastapi中，我最终选择了fastapi。相当长的一段时间里，我都是用Django在写后端，但是Django太臃肿了，重量级的框架很多地方难以学透，在现在前后端分离的大环境下，Django的模板语法优势也并不大

相反，fastapi只专注于后端接口开发，同时也提供了和node相似的异步处理程序。在学习fastapi过程中，记录了以下几种常见的接口请求方式：

一、主程序构建

在请求之前，先记录一下如何把后端服务跑起来

根目录下创建main.py文件，代码如下：

#!/usr/bin/env python
# -*- coding:utf-8 -*-
# author:HP
# datetime:2024/6/28 16:30

from fastapi import FastAPI
import uvicorn
from apps.app01 import app01

app = FastAPI()
app.include_router(app01)

if __name__ == '__main__':
    uvicorn.run("main:app", port=8001, reload=True)

两点需要注意：

  1. 路由分发，即app.include_router(app01)，路由处理函数写在于main文件同目录下的apps文件夹下，该文件夹下面有一个app01.py的路由处理文件，里面就是各种路由的处理函数，当一个项目同时存在多个子项时，可以创建多个app.py文件，实现路由分发

  2. 服务启动命令uvicorn.run("main:app", port=8001, reload=True)，很多情况下，需要在终端执行这句代码以启动服务，但这么操作非常不方便，也记不住，因此，把这行代码写在main函数中，只要运行这个程序，就可以正常启动服务了，注意，reload=True表示自动重启服务，也就是代码改了之后，服务就会自动重启

二、请求类型

请求类型大概包括路径参数、查询参数、请求体参数、form表单上传和文件上传这么几种，其中文件上传是最复杂的，我先把全部的代码放进来，然后一一解释

apps/app01.py中的代码：

#!/usr/bin/env python
# -*- coding:utf-8 -*-
# author:HP
# datetime:2024/6/28 16:30
from fastapi import APIRouter, Form, File, UploadFile
from pydantic import BaseModel
from datetime import date, datetime
from typing import List
import os

app01 = APIRouter()


class User(BaseModel):
    name: str = 'root'  # 默认值
    age: int
    birth: date
    friends: List[int]


# 路径参数
@app01.get('/user/{id}')
async def get_user(id: int):
    print(id)
    return {
        "user_id": id
    }


# 查询参数
@app01.get("/jobs")
async def get_jobs(kd, gj=None, xl=None):
    return {
        "kd": kd,
        "gj": gj,
        "xl": xl,
    }


# 请求体参数
@app01.post("/data")
async def get_data(data: User):
    return data


# form表单数据
@app01.post('/register')
async def register(username: str = Form(), password: str = Form()):
    print(username)
    print('----------')
    print(password)
    return {
        "username": username,
    }


# 上传单个文件
@app01.post('/upload')
async def upload(file: bytes = File()):
    # 这里的file直接就是字节流，没有其他信息
    # 将文件存储到服务器
    # 获取当前时间，精确到毫秒
    current_time = datetime.now().strftime('%Y%m%d%H%M%S%f')[:-3]  # 去掉最后的毫秒部分的最后一位，确保文件名合法
    filename = current_time + '.jpg'
    path = os.path.join('imgs', filename)
    with open(path, 'wb') as f:
        f.write(file)

    return {
        "status": 1,
        "message": "success",
        "file": filename,
    }


# 上传多个文件
@app01.post('/uploads')
async def uploads(files: List[bytes] = File()):
    for file in files:
        print(len(file))
    return {
        "file": len(files)
    }


# 更加常用的文件上传方式，但postman中无法测试，因为数据中不支持UploadFile类型的数据
# 上传单个文件
@app01.post('/uploadFlie')
async def upload_file(file: UploadFile):
    current_time = datetime.now().strftime('%Y%m%d%H%M%S%f')[:-3]  # 去掉最后的毫秒部分的最后一位，确保文件名合法
    filename = current_time + '.jpg'
    path = os.path.join('imgs', filename)
    with open(path, 'wb') as f:
        for line in file.file:
            f.write(line)
    return {
        "origin_name": file.filename,
        "sever_name": filename,
    }


# 上传多个文件
@app01.post('/uploadFiles')
async def upload_files(files: List[UploadFile]):
    print(files)
    return {
        "file": len(files),
    }

1、路径参数

# 路径参数
@app01.get('/user/{id}')
async def get_user(id: int):
    print(id)
    return {
        "user_id": id
    }

请求示例：

image-20240702102934385

请求参数写在路径上，通常用于处理表格中的数据，比较好理解

2、查询参数

# 查询参数
@app01.get("/jobs")
async def get_jobs(kd, gj=None, xl=None):
    return {
        "kd": kd,
        "gj": gj,
        "xl": xl,
    }

postman中的请求示例：

image-20240702103154842

这也挺简单的，以查询参数的形式传递参数，通常来说，就是路由中?后面的都是查询参数，用&分割

3、请求体参数

一般用是post请求中，把参数封装在body（请求体）中

# 请求体参数
@app01.post("/data")
async def get_data(data: User):
    return data

这里用到了pydantic中的BaseModel模型，User模型继承于BaseModel，主要得记住写法

同样看看postman中的请求示例：

image-20240702103648063

在postman中，body参数要写在raw下，这里不是表单数据，不能写在x-www-form-urlencoded中

其实也挺简单的

4、form表单参数

这里正好与第3点请求体参数比较一下

# form表单数据
@app01.post('/register')
async def register(username: str = Form(), password: str = Form()):
    print(username)
    print('----------')
    print(password)
    return {
        "username": username,
    }

fastapi中封装好了Form表单数据的数据类型，这和postman中的x-www-form-urlencoded定义的form数据是一样的

看看postman中的请求示例：

image-20240702104116745

参数位置不一样

5、文件上传

（1）上传单个文件
# 上传单个文件
@app01.post('/upload')
async def upload(file: bytes = File()):
    # 这里的file直接就是字节流，没有其他信息
    # 将文件存储到服务器
    # 获取当前时间，精确到毫秒
    current_time = datetime.now().strftime('%Y%m%d%H%M%S%f')[:-3]  # 去掉最后的毫秒部分的最后一位，确保文件名合法
    filename = current_time + '.jpg'
    path = os.path.join('imgs', filename)
    with open(path, 'wb') as f:
        f.write(file)

    return {
        "status": 1,
        "message": "success",
        "file": filename,
    }

目标，前端上传文件，并将文件保存在服务器中与main.py同名的imgs文件夹下，文件名是当前时间（到毫秒）.jpg

注意，这里的file是字节流，可以直接写到文件中，同样，也可以在postman中测试

image-20240702104508468

服务器下的imgs文件夹下多了一张图片

image-20240702104558750

（2）上传多个文件
# 上传多个文件
@app01.post('/uploads')
async def uploads(files: List[bytes] = File()):
    for file in files:
        print(len(file))
    return {
        "file": len(files)
    }

这里没再写文件存储的过程，与上传单个文件差不多，看看postman中的示例：

image-20240702104810492

（3）UploadFile上传单个文件

前面两种情况应该已经能满足大部分情况了，但是，fastapi封装了一种专用于文件上传的UploadFile类，代码如下：

# 更加常用的文件上传方式，但postman中无法测试，因为数据中不支持UploadFile类型的数据
# 上传单个文件
@app01.post('/uploadFlie')
async def upload_file(file: UploadFile):
    current_time = datetime.now().strftime('%Y%m%d%H%M%S%f')[:-3]  # 去掉最后的毫秒部分的最后一位，确保文件名合法
    filename = current_time + '.jpg'
    path = os.path.join('imgs', filename)
    with open(path, 'wb') as f:
        for line in file.file:
            f.write(line)
    return {
        "origin_name": file.filename,
        "sever_name": filename,
    }

因为这是fastapi封装的，postman不兼容，所以postman没法测，用fastapi自带的接口测试文档看下示例：

image-20240702105207200

同样看看服务器端的imgs目录：

image-20240702105303058

可以看到，对应的地方多了一张图片

需要注意的是，这里上传的file，就并不再是纯字节流数据了，而是fastapi封装的UploadFile对象，需要知道这个对象里有哪些内容，可以查看源码，也可以借助编译器逐个去看

（4）UploadFile上传多个文件
# 上传多个文件
@app01.post('/uploadFiles')
async def upload_files(files: List[UploadFile]):
    print(files)
    return {
        "file": len(files),
    }

理解了UploadFile上传单个文件，多个文件就不难了，看看接口测试文档中的示例：

image-20240702105629868

无非是多了个添加item的选项而已

对象里有哪些内容，可以查看源码，也可以借助编译器逐个去看

好了，学习完接口的请求类型，后面应该要学习orm了。。

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

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

相关文章

传神论文中心｜第15期人工智能领域论文推荐

传神论文中心｜第15期人工智能领域论文推荐

在人工智能领域的快速发展中，我们不断看到令人振奋的技术进步和创新。近期，开放传神（OpenCSG）社区发现了一些值得关注的成就。传神社区本周也为对AI和大模型感兴趣的读者们提供了一些值得一读的研究工作的简要概述以及它们各自的论…
阅读更多...
【linux】虚拟机安装 BCLinux-R8-U4-Server-x86_64

【linux】虚拟机安装 BCLinux-R8-U4-Server-x86_64

目录 一、概述 1.1移动云Linux系统订阅服务 CLS 1.2 大云天元操作系统BC-Linux 二、安装 一、概述 1.1移动云Linux系统订阅服务 CLS 移动云Linux系统订阅服务 CLS （Cloud Linux Service）为使用BC-Linux操作系统的用户提供标准维保服务以及高级技术支…
阅读更多...
JVM原理（九）：JVM虚拟机工具之可视化故障处理工具

JVM原理（九）：JVM虚拟机工具之可视化故障处理工具

1. JHSDB:基于服务性代理的调试工具 JHSDB是一款基于服务性代理实现的进程外调试工具。 服务性代理是HotSpot虚拟机中一组用于映射Java虚拟机运行信息的、主要基于Java语言实现的API集合。 2. JConsole:Java监视与管理控制台 JConsole是一款基于JMX的可视化监视、管理工具。…
阅读更多...
矩阵、混剪、大盘，3大功能升级优化！助力企业高效管理！

矩阵、混剪、大盘，3大功能升级优化！助力企业高效管理！

在数字化转型的浪潮中，企业对于工具与技术的需求愈发强烈。 为满足市场需求，本月【云略】为各企业上线了便捷功能，赋能企业经营决策和业务增长。 矩阵管理 √【矩阵号管理】抖音支持设置城市IP 内容管理 √【混剪任务】支持关联智能发布计…
阅读更多...
模拟 ADC 的前端

模拟 ADC 的前端

ADC 的 SPICE 模拟 反复试验的方法将信号发送到 ADC 非常耗时，而且可能有效也可能无效。如果转换器捕获电压信息的关键时刻模拟输入引脚不稳定，则无法获得正确的输出数据。SPICE 模型允许您执行的步是验证所有模拟输入是否稳定，以便没有错误…
阅读更多...
百家讲坛 | 裴伟伟：企业中安全团队应当如何反馈漏洞

百家讲坛 | 裴伟伟：企业中安全团队应当如何反馈漏洞

作者简介：裴伟伟，洞源实验室创始人，国家网安基地网络安全行业专家，网安加社区特聘专家，持有CISSP、PMP证书，曾在HITCON、可信云大会、开源产业大会等安全论坛发表演讲。曾任国内某安全实验室负责人、某互金…
阅读更多...
3.js - 色调映射（renderer.toneMapping）

3.js - 色调映射（renderer.toneMapping）

// ts-nocheck// 引入three.js import * as THREE from three// 导入轨道控制器 import { OrbitControls } from three/examples/jsm/controls/OrbitControls// 导入lil.gui import { GUI } from three/examples/jsm/libs/lil-gui.module.min.js// 导入tween import * as TWEEN…
阅读更多...
Stable DIffusion 线稿上色+风格迁移教程，建议收藏！

Stable DIffusion 线稿上色+风格迁移教程，建议收藏！

前言 Stable Diffusion 线稿上色与风格迁移教程。 欢迎来到Stable Diffusion的线稿上色与风格迁移教程！在这个教程中，我们将引导你如何使用Stable Diffusion技术，将你的线稿作品进行上色，并迁移到不同的艺术风格。让我们开始吧&a…
阅读更多...
双端队列广搜——AcWing 175. 电路维修

双端队列广搜——AcWing 175. 电路维修

双端队列广搜 定义 双端队列广搜（Breadth-First Search with a Deque）是一种图或树的遍历算法变体，它利用了双端队列（Deque，全称Double Ended Queue，允许在其两端进行插入和删除操作）作为数据…
阅读更多...
CentOS7源码安装nginx并编写服务脚本

CentOS7源码安装nginx并编写服务脚本

华子目录 准备下载nginx源码包关闭防火墙关闭selinux安装依赖环境 解压编译安装测试编写服务脚本，通过systemctl实现服务启动与关闭测试 准备 下载nginx源码包 在源码安装前，我们得先下载nginx源码包https://nginx.org/download/这里我下载的是nginx-1…
阅读更多...
PHP景区旅游多商户版微信小程序系统源码

PHP景区旅游多商户版微信小程序系统源码

解锁景区新玩法！​ 引言：一站式旅行新体验 厌倦了传统景区的单调游览？想要一次旅行就能体验多种风情？那么，“景区旅游多商户版”绝对是你的不二之选！这个创新模式将景区内多个商户资源整合，为…
阅读更多...
Golang-context理解

Golang-context理解

golang-context笔记整理 golang为何设计context？代码上理解原理空context类cancelCtx类.withcancelctx方法 timerCtx类valueCtx类 golang为何设计context？ 有并发特性的语言中，都会有一种说法：创建异步线程或者携程的时候&#x…
阅读更多...
【Altium】如何处理PCB上所有焊盘被误盖油

【Altium】如何处理PCB上所有焊盘被误盖油

【更多软件使用问题请点击亿道电子官方网站】 1、 文档目标 解决焊盘被误盖油的操作 2、 问题场景 所有焊盘都可以设置为盖油或不盖油，由于焊盘需要用来焊接元器件，所以都不会设置盖油。由于误操作或者创建封装时设置错误，造成一定数量的焊盘…
阅读更多...
【GD32】07 - UART串口通信

【GD32】07 - UART串口通信

GD32F407中的UART 今天我用的型号是GD32F407，用其他型号的小伙伴在使用UART的时候注意一下自己手上板子的资源就行，我们使用固件库就算是不同型号其实也是没有什么太大差别的。 我们废话不多说，直接开始讲怎么使用UART。 首先我们先确定串…
阅读更多...
【面试干货】Static关键字的用法详解

【面试干货】Static关键字的用法详解

【面试干货】Static关键字的用法详解 1、Static修饰内部类2、Static修饰方法3、Static修饰变量4、Static修饰代码块5、总结 💖The Begin💖点点关注，收藏不迷路💖 在Java编程语言中，static是一个关键字，它可…
阅读更多...
猫头虎博主全栈前沿AI技术领域矩阵社群

猫头虎博主全栈前沿AI技术领域矩阵社群

猫头虎博主全栈前沿AI技术领域矩阵社群 👋大家好，我是猫头虎！今天我要向大家介绍一个非常重要的社群矩阵——专为全栈前沿AI技术领域的朋友们打造的各种技术交流和资源互助的社群。这些社群不仅能帮助大家快速提升技术水平，还能拓…
阅读更多...
深度学习笔记: 最详尽解释混淆矩阵 Confusion Matrix

深度学习笔记: 最详尽解释混淆矩阵 Confusion Matrix

欢迎收藏Star我的Machine Learning Blog:https://github.com/purepisces/Wenqing-Machine_Learning_Blog。如果收藏star, 有问题可以随时与我交流, 谢谢大家！ 混淆矩阵 假设我们有包含临床测量数据的医疗数据，例如胸痛、良好的血液循环、动脉阻塞和体重…
阅读更多...
LeetCode 子集

LeetCode 子集

原题链接78. 子集 - 力扣（LeetCode） 这是一道暴力搜索问题参考大佬们的题解，对这类题目做出一下总结 1.确定递归参数变量 2.递归结束条件 3.做出选择，递归调用进入下一层 4.回溯，返回到递归前的状态 要完成前面这…
阅读更多...
Golang内存分配

Golang内存分配

Go内存分配语雀笔记整理 Golang内存模型设计理念思考核心代码阅读mspanmcachemcentral中心缓存mheap分配过程 Golang内存模型设计理念思考 golang内存分配基于TCmalloc模型，它核心在于：空间换时间，一次缓存，多次复用；…
阅读更多...
重大丨深中通道今通车！继港珠澳大桥后，三思再度点亮世界工程

重大丨深中通道今通车！继港珠澳大桥后，三思再度点亮世界工程

6月30日下午3时，国家重大工程深中通道正式通车试运营，向世界再次展示中国智慧和基建实力。已承接过包括港珠澳大桥海底隧道在内2500多条隧道照明工程的上海三思电子工程有限公司，为这座超级工程提供了LED隧道照明、东西人工岛照明及显示、管理…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023