fastAPI接口的请求与响应——基础

1. 后端接口

1.接口实现

pip install fastapi
pip install uvicorn

# api.py
from pydantic import BaseModel
from fastapi import FastAPI
import uvicorn
import os


#  定义请求体模型
class Payload(BaseModel):
    key1: str
    key2: str


# 创建一个FastAPI应用程序实例
app = FastAPI()

# 定义路由(使用装饰器将函数绑定到特定的路径和HTTP方法)
@app.get("/")
async def root():
    return {"message": "Hello World"}

## get对于多个请求参数:
@app.get("/items/{item_id}")
def read_item(item_id: int, q: str = None):
    return {"item_id": item_id, "q": q}

## post对于多个请求参数:
@app.post("/api")
async def handle_post_request(payload: Payload):
    return {"message": f"Received key1: {payload.key1} and key2: {payload.key2}"}
    

代码解析:
  1) @app.get和@app.post为两种不同的请求方法
  2) BaseModel 是 Pydantic 库中的一个类,它被用于创建数据模型,用于解析和验证数据。在 FastAPI 中,BaseModel 经常用于定义请求体的结构,确保传入的数据符合预期的格式。Pydantic 模型提供了声明式的数据验证,这意味着你可以在模型类中定义属性及其类型,Pydantic 将自动执行验证。如果传入的数据不符合模型定义的规则,Pydantic 将抛出异常。
  3) 在这个例子中,Payload 类有两个属性:key1 和 key2,它们都被声明为字符串类型 (str)。当 FastAPI 接收到一个 HTTP 请求时,它会尝试将请求体中的 JSON 数据解析为这个模型如果请求体中的 JSON 数据符合这个模型的定义(即有 key1 和 key2 属性,并且它们都是字符串类型),那么这个请求就会被成功解析。否则,FastAPI 会返回一个错误响应,说明哪些字段不符合预期

2.接口启动
方式一:uvicorn 内嵌式
在上述代码所在的api.pi中加入以下代码后,运行api.py文件即可。

if __name__ == "__main__":
	uvicorn.run(app, host="0.0.0.0", port=int(os.environ.get("API_PORT", 8000)), workers=1)

方式二:uvicorn 外启式
在命令行输入命令:uvicorn api:app --host 0.0.0.0 --port 8000 --reload

main:启动服务的py文件名
app:服务对象名(FastAPI创建的对象)
–-host:ip地址
–-port:端口
–-reload:代码修改后自动重启服务。仅在开发时使用,上线后不要带这个参数,会降低性能

2.API调用

注意:后端代码此时都是非流式输出,所以访问时只需要处理非流式响应即可。

import requests

url = 'http://localhost:8000/api'  # 假设你的应用运行在本地8000端口
payload = {'key1': 'value1', 'key2': 'value2'}

# 请求方式1:
response = requests.post(url, json=payload)
print(response.json())

# 请求方式2:推荐该请求方式
'''
确保了资源的正确初始化和清理,特别是在异常发生的情况下。具体来说,with 语句提供了一种简洁的方式,可以自动处理资源的获取和释放,这对于流式响应尤为重要。
1. 自动关闭连接:当你使用 with 语句时,一旦代码块结束,Python 会自动调用 r.close() 来关闭请求连接。这对于流式响应尤为重要,因为如果不显式关闭连接,可能会导致连接池中的连接无法被释放,从而影响性能或导致资源泄漏5。
2. 异常安全:即使在处理流式响应的过程中发生了异常,with 语句也会确保连接被正确关闭。这有助于防止未处理的异常导致连接保持打开状态,进而消耗不必要的资源6。
3. 代码清晰性:使用 with 语句可以使代码更加简洁和易读。它明确地表明了资源的生命周期,并且减少了手动管理资源的需求,降低了出错的可能性。
'''
# with requests.post(url, json=payload) as r:
#     r.raise_for_status()  # 检查请求是否成功
#     print(r.json())

3.注意

api的接口函数如果没有async修饰就是同步函数。如果有async修饰,但内部没有await修饰,那么其实也还是同步函数;有await时,才能进行异步处理。

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

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

B站bilibili视频转文字字幕下载方法

本文将讲述介绍一种使用本地工具如何快速的下载B站的字幕为本地文本文件的方法。 通常获取B站字幕需要在浏览器中安装第三方插件,通过插件获取字幕。随着大模型,生成式AI,ChatGPT的应用,B站也提供了AI小助手对视频的内容进行总结…

CSS3 实现火焰-小火苗效果

创建 CSS3 火焰效果可以通过组合 CSS 动画、伪元素 和 渐变 来实现。以下是一个简单的实现步骤&#xff0c;展示如何制作动态火焰效果 1. HTML 结构 我们只需要一个简单的 div 容器&#xff1a; <div class"fire"></div>2. CSS 实现 基础样式 使用 …

新能源汽车充电需求攀升,智慧移动充电服务有哪些实际应用场景?

在新能源汽车行业迅猛发展的今天&#xff0c;智慧充电桩作为支持这一变革的关键基础设施&#xff0c;正在多个实际应用场景中发挥着重要作用。从公共停车场到高速公路服务区&#xff0c;从企业园区到住宅小区&#xff0c;智慧充电桩不仅提供了便捷的充电服务&#xff0c;还通过…

git remote -v(--verbose)显示你的 Git 仓库配置的远程仓库的详细信息

git remote -v 是一个 Git 命令&#xff0c;用于显示你的 Git 仓库配置的远程仓库的详细信息。 当你执行 git remote -v 命令时&#xff0c;你会看到类似以下的输出&#xff1a; origin https://github.com/your-username/your-repo.git (fetch) origin https://github.com…

Java Web项目部署教程简单实用

前些天发现了一个巨牛的人工智能学习网站&#xff0c;通俗易懂&#xff0c;风趣幽默&#xff0c; 忍不住分享一下给大家。点击跳转到网站 学习总结 1、掌握 JAVA入门到进阶知识(持续写作中……&#xff09; 2、学会Oracle数据库入门到入土用法(创作中……&#xff09; 3、手把…

【爬虫一】python爬虫基础合集一

【爬虫一】python爬虫基础合集一 1. 网络请求了解1.1. 请求的类型1.2. 网络请求协议1.3. 网络请求过程简单图解1.4. 网络请求Headers(其中的关键字释义)&#xff1a;请求头、响应头 2. 网络爬虫的基本工作节点2.1. 了解简单网络请求获取响应数据的过程所涉及要点 1. 网络请求了…

清理C盘小记

突然C盘就爆满了&#xff0c;想当初还是给他预留了120G的空间&#xff0c;感觉到现在也不够用了&#xff0c;担心出现死机的情况就赶紧进行了清理。有一说一&#xff0c;清理回收站是真的有用。 参考&#xff1a;C盘清理指南&#xff0c;清理出30G起&#xff0c;超详细总结&am…

Ansible playbook 详解与实战操作

一、概述 playbook 与 ad-hoc 相比,是一种完全不同的运用 ansible 的方式&#xff0c;类似与 saltstack 的 state 状态文件。ad-hoc 无法持久使用&#xff0c;playbook 可以持久使用。 playbook 是由一个或多个 play 组成的列表&#xff0c;play 的主要功能在于将事先归并为一…

seata-2阶段提交-笔记3

本文属于B站图灵课堂springcloud笔记系列。 前面整理过2篇:seata 2阶段提交实现代码-笔记1-CSDN博客 扫描GlobalTransactional注解 seata 2阶段提交实现代码-笔记2-CSDN博客 TC生成XID&#xff0c;并保存到global_table表。 本篇继续整理 执行业务逻辑&#xff0c;提交本地…

Docker如何运行一个Java的jar包程序

Docker如何运行一个Java的jar包程序 1、jar包程序 2、start.sh运行jar包脚本 #!/bin/bash #进入目录 cd /app #1.下载SDK并安装 java -jar SDKDown1.4.jar #2.加载环境变量 export LD_LIBRARY_PATH/opt/casb/CipherSuiteSdk_linux/lib echo $LD_LIBRARY_PATH #3.执行SDK java …

Pycharm访问MongoDB数据库

MongoDB的基础操作 1. 创建连接 #导入pymongo中的用于操作数据库的客户端 from pymongo import MongoClient #创建客户端对象&#xff0c;连接MongoDB服务器 client MongoClient(mongodb://admin:admin123456localhost:27017) 2. 数据的增删改查 2.1 数据的写入 from mon…

【Python】编写一个函数,将指定的罗马字符转换为数字的形式。

#编写一个函数&#xff0c;将指定的罗马字符转换为数字的形式。R2N {I:1, V:5, X:10, L:50, C:100, D:500, M:1000}def roman2num(s):r 0n len(s)for i, ch in enumerate(s):v R2N[ch]if i < n-1 and v < R2N[s[i1]]:r - velse:r vreturn r;s input("请输入一…

【深度学习总结】使用PDF构建RAG:结合Langchain和通义千问

【深度学习总结】使用PDF构建RAG&#xff1a;结合Langchain和通义千问 使用平台&#xff1a;趋动云&#xff0c;注册送算力 前言 在大型语言模型&#xff08;LLMs&#xff09;应用领域&#xff0c;我们面临着大量挑战&#xff0c;从特定领域知识的匮乏到信息准确性的窘境&am…

GB28181系列三:GB28181流媒体服务器ZLMediaKit

我的音视频/流媒体开源项目(github) GB28181系列目录 目录 一、ZLMediaKit介绍 二、 ZLMediaKit安装、运行(Ubuntu) 1、安装 2、运行 3、配置 三、ZLMediaKit使用 一、ZLMediaKit介绍 ZLMediaKit是一个基于C11的高性能运营级流媒体服务框架&#xff0c;项目地址&#xf…

React 第十七节 useMemo用法详解

概述 useMemo 是React 中的一个HOOK&#xff0c;用于根据依赖在每次渲染时候缓存计算结果&#xff1b; 大白话就是&#xff0c;只有依赖项发生变化时候&#xff0c;才会重新渲染为新计算的值&#xff0c;否则就还是取原来的值&#xff0c;有点类似 vue 中的 computed 计算属性…

若依前后端分离版集成ShardingSphere-补充版代码演示

拉取项目&#xff1a;https://gitee.com/y_project/RuoYi-Vue。前后端分离版本新建数据库&#xff0c;字符集选择utf8mb4。导入mysql文件。 主pom文件中引入依赖 <!-- 分库分表引擎 --><dependency><groupId>org.apache.shardingsphere</groupId><…

Postman接口测试:全局变量/接口关联/加密/解密

&#x1f345; 点击文末小卡片&#xff0c;免费获取软件测试全套资料&#xff0c;资料在手&#xff0c;涨薪更快 全局变量和环境变量 全局变量&#xff1a;在postman全局生效的变量&#xff0c;全局唯一 环境变量&#xff1a;在特定环境下生效的变量&#xff0c;本环境内唯一 …

基于PHP的民宿预订管理系统

有需要请加文章底部Q哦 可远程调试 基于PHP的民宿预订管理系统 一 介绍 此民宿预订管理系统基于原生PHP开发&#xff0c;数据库mysql&#xff0c;前端bootstrap。系统角色分为用户和管理员。(附带配套设计文档) 技术栈 phpmysqlbootstrapphpstudyvscode 二 功能 用户 1 注册…

Elasticsearch:使用 Open Crawler 和 semantic text 进行语义搜索

作者&#xff1a;来自 Elastic Jeff Vestal 了解如何使用开放爬虫与 semantic text 字段结合来轻松抓取网站并使其可进行语义搜索。 Elastic Open Crawler 演练 我们在这里要做什么&#xff1f; Elastic Open Crawler 是 Elastic 托管爬虫的后继者。 Semantic text 是 Elasti…

NVM:安装配置使用(详细教程)

文章目录 一、简介二、安装 nvm三、配置 nvm 镜像四、配置环境变量五、使用教程5.1 常用命令5.2 具体案例 六、结语 一、简介 在实际的开发和学习中可能会遇到不同项目的 node 版本不同&#xff0c;而出现的兼容性问题。 而 nvm 就可以很好的解决这个问题&#xff0c;它可以在…