【FastAPI】P3 请求与响应

2024-02-20 15:04
文章标签 请求 响应 p3 fastapi

本文主要是介绍【FastAPI】P3 请求与响应,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

目录

  • 请求
    • 路径参数
    • 查询参数
  • 响应
    • JSON 响应
    • 文本响应
    • 返回 Pydantic 模型

在网络通讯中,请求(Request)响应(Response) 扮演着至关重要的角色,它们构成了客户端与服务器间互动的根本理念。

  • 请求,指的是客户端向服务器请求数据;
  • 响应,指的是服务器发送给客户端的 HTTP 响应;

总的来说,当客户端向服务器发送一个 HTTP 请求时,服务器会处理这个请求,并返回一个 HTTP 响应。


请求

FastAPI,支持多种类型的请求数据,如路径参数、查询参数等。

路径参数

把参数设置在路径上,识别资源的具体实例。

# 参数 user_id 放在路径上,识别资源的具体实例。
@app.get("/users/{user_id}")

实现步骤:

1. 运行完整代码:

from fastapi import FastAPIapp = FastAPI()@app.get("/users/{user_id}")
def get_user(user_id: int):return {"user_id": user_id}

2. 部署 uvicorn 服务器:

uvicorn main:app --reload

在这里插入图片描述

3. 通过网址访问:

http://127.0.0.1:8000/users/10010


查询参数

通过在路径后面添加问号(?)来附加查询参数,以提供额外的信息或者过滤条件。

@app.get("/users")
# 网址如下:
http://127.0.0.1:8000/users?user_id=10010&user_name=xuhongduo

实现步骤:

1. 运行完整代码:

from fastapi import FastAPIapp = FastAPI()@app.get("/users/")
def get_user(user_id: int, user_name: str):return {"user_id": user_id, "user_name": user_name}

2. 部署 uvicorn 服务器:

# 如果已部署,那么无需重启,reload在代码修改时自动重启服务器
uvicorn main:app --reload

3. 通过网址访问:

http://127.0.0.1:8000/users/?user_id=10010&user_name=xuhongduo


响应

响应一般包含:

  • 状态码:200表示成功,404表示未找到,500表示服务器错误等;
  • 响应体:文本、JSON、二进制文本等;

FastAPI 支持多种类型的响应,包括 JSON 响应、文本响应、文件响应、重定向响应和错误响应。

JSON 响应

JSON 响应是最常用的响应类型,用于传输结构化数据。

return {"user_id": user_id, "user_name": user_name}

文本响应

文本响应发送纯文本数据。

return "Hello, World!"

返回 Pydantic 模型

路由处理函数返回一个 Pydantic 模型实例,FastAPI 将自动将其转换为 JSON 格式,并作为响应发送给客户端:

1. 运行完整代码:

from pydantic import BaseModel
from typing import Optionalclass User(BaseModel):id: intname: stremail: Optional[str] = Nonefrom fastapi import FastAPI, HTTPExceptionapp = FastAPI()users = {1: {"name": "Alice", "email": "alice@example.com"},2: {"name": "Bob"},
}@app.get("/users/{user_id}")
def read_user(user_id: int):user = users.get(user_id)if user:return userelse:raise HTTPException(status_code=404, detail="User not found")

2. 通过网址访问:

http://127.0.0.1:8000/users/1

3. FastAPI 自动将 Pydantic 模型实例转换为 JSON 格式:

在这里插入图片描述

有关 FastAPI Pydantic 模型,请看 【FastAPI】P4 FastAPI Pydantic


以上
如有任何问题,请联系或留言,谢谢

2024.2.19

这篇关于【FastAPI】P3 请求与响应的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/728611

相关文章

SpringBoot请求参数接收控制指南分享

《SpringBoot请求参数接收控制指南分享》:本文主要介绍SpringBoot请求参数接收控制指南,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Spring Boot 请求参数接收控制指南1. 概述2. 有注解时参数接收方式对比3. 无注解时接收参数默认位置

Spring 请求之传递 JSON 数据的操作方法

《Spring请求之传递JSON数据的操作方法》JSON就是一种数据格式,有自己的格式和语法,使用文本表示一个对象或数组的信息,因此JSON本质是字符串,主要负责在不同的语言中数据传递和交换,这... 目录jsON 概念JSON 语法JSON 的语法JSON 的两种结构JSON 字符串和 Java 对象互转

html5的响应式布局的方法示例详解

《html5的响应式布局的方法示例详解》:本文主要介绍了HTML5中使用媒体查询和Flexbox进行响应式布局的方法,简要介绍了CSSGrid布局的基础知识和如何实现自动换行的网格布局,详细内容请阅读本文,希望能对你有所帮助... 一 使用媒体查询响应式布局        使用的参数@media这是常用的

SpringMVC获取请求参数的方法

《SpringMVC获取请求参数的方法》:本文主要介绍SpringMVC获取请求参数的方法,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下... 目录1、通过ServletAPI获取2、通过控制器方法的形参获取请求参数3、@RequestParam4、@

鸿蒙中Axios数据请求的封装和配置方法

《鸿蒙中Axios数据请求的封装和配置方法》:本文主要介绍鸿蒙中Axios数据请求的封装和配置方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录1.配置权限 应用级权限和系统级权限2.配置网络请求的代码3.下载在Entry中 下载AxIOS4.封装Htt

springboot filter实现请求响应全链路拦截

《springbootfilter实现请求响应全链路拦截》这篇文章主要为大家详细介绍了SpringBoot如何结合Filter同时拦截请求和响应,从而实现​​日志采集自动化,感兴趣的小伙伴可以跟随小... 目录一、为什么你需要这个过滤器?​​​二、核心实现:一个Filter搞定双向数据流​​​​三、完整代码

AJAX请求上传下载进度监控实现方式

《AJAX请求上传下载进度监控实现方式》在日常Web开发中,AJAX(AsynchronousJavaScriptandXML)被广泛用于异步请求数据,而无需刷新整个页面,:本文主要介绍AJAX请... 目录1. 前言2. 基于XMLHttpRequest的进度监控2.1 基础版文件上传监控2.2 增强版多

Python FastAPI+Celery+RabbitMQ实现分布式图片水印处理系统

《PythonFastAPI+Celery+RabbitMQ实现分布式图片水印处理系统》这篇文章主要为大家详细介绍了PythonFastAPI如何结合Celery以及RabbitMQ实现简单的分布式... 实现思路FastAPI 服务器Celery 任务队列RabbitMQ 作为消息代理定时任务处理完整

一文详解SpringBoot响应压缩功能的配置与优化

《一文详解SpringBoot响应压缩功能的配置与优化》SpringBoot的响应压缩功能基于智能协商机制,需同时满足很多条件,本文主要为大家详细介绍了SpringBoot响应压缩功能的配置与优化,需... 目录一、核心工作机制1.1 自动协商触发条件1.2 压缩处理流程二、配置方案详解2.1 基础YAML

SpringBoot使用OkHttp完成高效网络请求详解

《SpringBoot使用OkHttp完成高效网络请求详解》OkHttp是一个高效的HTTP客户端,支持同步和异步请求,且具备自动处理cookie、缓存和连接池等高级功能,下面我们来看看SpringB... 目录一、OkHttp 简介二、在 Spring Boot 中集成 OkHttp三、封装 OkHttp