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

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

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

如何解决Spring MVC中响应乱码问题

《如何解决SpringMVC中响应乱码问题》:本文主要介绍如何解决SpringMVC中响应乱码问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Spring MVC最新响应中乱码解决方式以前的解决办法这是比较通用的一种方法总结Spring MVC最新响应中乱码解

Go语言中最便捷的http请求包resty的使用详解

《Go语言中最便捷的http请求包resty的使用详解》go语言虽然自身就有net/http包,但是说实话用起来没那么好用,resty包是go语言中一个非常受欢迎的http请求处理包,下面我们一起来学... 目录安装一、一个简单的get二、带查询参数三、设置请求头、body四、设置表单数据五、处理响应六、超

Python FastAPI入门安装使用

《PythonFastAPI入门安装使用》FastAPI是一个现代、快速的PythonWeb框架,用于构建API,它基于Python3.6+的类型提示特性,使得代码更加简洁且易于绶护,这篇文章主要介... 目录第一节:FastAPI入门一、FastAPI框架介绍什么是ASGI服务(WSGI)二、FastAP

Qt实现发送HTTP请求的示例详解

《Qt实现发送HTTP请求的示例详解》这篇文章主要为大家详细介绍了如何通过Qt实现发送HTTP请求,文中的示例代码讲解详细,具有一定的借鉴价值,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1、添加network模块2、包含改头文件3、创建网络访问管理器4、创建接口5、创建网络请求对象6、创建一个回复对

springMVC返回Http响应的实现

《springMVC返回Http响应的实现》本文主要介绍了在SpringBoot中使用@Controller、@ResponseBody和@RestController注解进行HTTP响应返回的方法,... 目录一、返回页面二、@Controller和@ResponseBody与RestController

SpringBoot项目注入 traceId 追踪整个请求的日志链路(过程详解)

《SpringBoot项目注入traceId追踪整个请求的日志链路(过程详解)》本文介绍了如何在单体SpringBoot项目中通过手动实现过滤器或拦截器来注入traceId,以追踪整个请求的日志链... SpringBoot项目注入 traceId 来追踪整个请求的日志链路,有了 traceId, 我们在排

如何使用Java实现请求deepseek

《如何使用Java实现请求deepseek》这篇文章主要为大家详细介绍了如何使用Java实现请求deepseek功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1.deepseek的api创建2.Java实现请求deepseek2.1 pom文件2.2 json转化文件2.2

python使用fastapi实现多语言国际化的操作指南

《python使用fastapi实现多语言国际化的操作指南》本文介绍了使用Python和FastAPI实现多语言国际化的操作指南,包括多语言架构技术栈、翻译管理、前端本地化、语言切换机制以及常见陷阱和... 目录多语言国际化实现指南项目多语言架构技术栈目录结构翻译工作流1. 翻译数据存储2. 翻译生成脚本