三周精通FastAPI:36 OpenAPI 回调

官方文档:

OpenAPI 回调¶

您可以创建触发外部 API 请求的路径操作 API,这个外部 API 可以是别人创建的,也可以是由您自己创建的。

API 应用调用外部 API 时的流程叫做回调。因为外部开发者编写的软件发送请求至您的 API,然后您的 API 要进行回调,并把请求发送至外部 API。

此时,我们需要存档外部 API 的信息,比如应该有哪些路径操作,返回什么样的请求体,应该返回哪种响应等。

使用回调的应用¶

示例如下。

假设要开发一个创建发票的应用。

发票包括 idtitle(可选)、customertotal 等属性。

API 的用户 (外部开发者)要在您的 API 内使用 POST 请求创建一条发票记录。

(假设)您的 API 将:

  • 把发票发送至外部开发者的消费者
  • 归集现金
  • 把通知发送至 API 的用户(外部开发者)
    • 通过(从您的 API)发送 POST 请求至外部 API (即回调)来完成

常规 FastAPI 应用¶

添加回调前,首先看下常规 API 应用是什么样子。

常规 API 应用包含接收 Invoice 请求体的路径操作,还有包含回调 URL 的查询参数 callback_url。这部分代码很常规,您对绝大多数代码应该都比较熟悉了:

from typing import Unionfrom fastapi import APIRouter, FastAPI
from pydantic import BaseModel, HttpUrlapp = FastAPI()class Invoice(BaseModel):id: strtitle: Union[str, None] = Nonecustomer: strtotal: floatclass InvoiceEvent(BaseModel):description: strpaid: boolclass InvoiceEventReceived(BaseModel):ok: boolinvoices_callback_router = APIRouter()@invoices_callback_router.post("{$callback_url}/invoices/{$request.body.id}", response_model=InvoiceEventReceived
)
def invoice_notification(body: InvoiceEvent):pass@app.post("/invoices/", callbacks=invoices_callback_router.routes)
def create_invoice(invoice: Invoice, callback_url: Union[HttpUrl, None] = None):"""Create an invoice.This will (let's imagine) let the API user (some external developer) create aninvoice.And this path operation will:* Send the invoice to the client.* Collect the money from the client.* Send a notification back to the API user (the external developer), as a callback.* At this point is that the API will somehow send a POST request to theexternal API with the notification of the invoice event(e.g. "payment successful")."""# Send the invoice, collect the money, send the notification (the callback)return {"msg": "Invoice received"}

"提示"

callback_url 查询参数使用 Pydantic 的 URL 类型。

此处唯一比较新的内容是路径操作装饰器中的 callbacks=invoices_callback_router.routes参数,下文介绍。

存档回调¶

实际的回调代码高度依赖于您自己的 API 应用。

并且可能每个应用都各不相同。回调代码可能只有一两行,比如:

callback_url = "https://example.com/api/v1/invoices/events/"
requests.post(callback_url, json={"description": "Invoice paid", "paid": True})

但回调最重要的部分可能是,根据 API 要发送给回调请求体的数据等内容,确保您的 API 用户(外部开发者)正确地实现外部 API

因此,我们下一步要做的就是添加代码,为从 API 接收回调的外部 API存档。

这部分文档在 /docs 下的 Swagger API 文档中显示,并且会告诉外部开发者如何构建外部 API

本例没有实现回调本身(只是一行代码),只有文档部分。

"提示"

实际的回调只是 HTTP 请求。

实现回调时,要使用 HTTPX 或 Requests。

编写回调文档代码¶

应用不执行这部分代码,只是用它来记录 外部 API 。

但,您已经知道用 FastAPI 创建自动 API 文档有多简单了。

我们要使用与存档外部 API 相同的知识……通过创建外部 API 要实现的路径操作(您的 API 要调用的)。

"提示"

编写存档回调的代码时,假设您是外部开发者可能会用的上。并且您当前正在实现的是外部 API,不是您自己的 API

临时改变(为外部开发者的)视角能让您更清楚该如何放置外部 API 响应和请求体的参数与 Pydantic 模型等。

创建回调的 APIRouter

首先,新建包含一些用于回调的 APIRouter

from fastapi import APIRouter, FastAPIinvoices_callback_router = APIRouter()

创建回调路径操作

创建回调路径操作也使用之前创建的 APIRouter

它看起来和常规 FastAPI 路径操作差不多:

  • 声明要接收的请求体,例如,body: InvoiceEvent
  • 还要声明要返回的响应,例如,response_model=InvoiceEventReceived
 
class InvoiceEvent(BaseModel):description: strpaid: boolclass InvoiceEventReceived(BaseModel):ok: boolinvoices_callback_router = APIRouter()@invoices_callback_router.post("{$callback_url}/invoices/{$request.body.id}", response_model=InvoiceEventReceived
)
def invoice_notification(body: InvoiceEvent):pass

回调路径操作与常规路径操作有两点主要区别:

  • 它不需要任何实际的代码,因为应用不会调用这段代码。它只是用于存档外部 API。因此,函数的内容只需要 pass 就可以了
  • 路径可以包含 OpenAPI 3 表达式(详见下文),可以使用带参数的变量,以及发送至您的 API 的原始请求的部分

回调路径表达式¶

回调路径支持包含发送给您的 API 的原始请求的部分的  OpenAPI 3 表达式。

本例中是字符串

"{$callback_url}/invoices/{$request.body.id}" 

因此,如果您的 API 用户(外部开发者)发送请求到您的 API:

https://yourapi.com/invoices/?callback_url=https://www.external.org/events 

使用如下 JSON 请求体:

{ "id": "2expen51ve", "customer": "Mr. Richie Rich", "total": "9999" } 

然后,您的 API 就会处理发票,并在某个点之后,发送回调请求至 callback_url(外部 API):

https://www.external.org/events/invoices/2expen51ve 

JSON 请求体包含如下内容:

{ "description": "Payment celebration", "paid": true } 

它会预期外部 API 的响应包含如下 JSON 请求体:

{ "ok": true } 

"提示"

注意,回调 URL包含 callback_url (https://www.external.org/events)中的查询参数,还有 JSON 请求体内部的发票 ID(2expen51ve)。

添加回调路由¶

至此,在上文创建的回调路由里就包含了回调路径操作(外部开发者要在外部 API 中实现)。现在使用 API 路径操作装饰器的参数 callbacks,从回调路由传递属性 .routes(实际上只是路由/路径操作的列表):

@app.post("/invoices/", callbacks=invoices_callback_router.routes)
def create_invoice(invoice: Invoice, callback_url: Union[HttpUrl, None] = None):

"提示"

注意,不能把路由本身(invoices_callback_router)传递给 callback=,要传递 invoices_callback_router.routes 中的 .routes 属性。

查看文档¶

现在,使用 Uvicorn 启动应用,打开 http://127.0.0.1:8000/docs。

就能看到文档的路径操作已经包含了回调的内容以及外部 API

实践

源代码

将代码写入callback.py文件

from typing import Unionfrom fastapi import APIRouter, FastAPI
from pydantic import BaseModel, HttpUrlapp = FastAPI()class Invoice(BaseModel):id: strtitle: Union[str, None] = Nonecustomer: strtotal: floatclass InvoiceEvent(BaseModel):description: strpaid: boolclass InvoiceEventReceived(BaseModel):ok: boolinvoices_callback_router = APIRouter()@invoices_callback_router.post("{$callback_url}/invoices/{$request.body.id}", response_model=InvoiceEventReceived
)
def invoice_notification(body: InvoiceEvent):pass@app.post("/invoices/", callbacks=invoices_callback_router.routes)
def create_invoice(invoice: Invoice, callback_url: Union[HttpUrl, None] = None):"""Create an invoice.This will (let's imagine) let the API user (some external developer) create aninvoice.And this path operation will:* Send the invoice to the client.* Collect the money from the client.* Send a notification back to the API user (the external developer), as a callback.* At this point is that the API will somehow send a POST request to theexternal API with the notification of the invoice event(e.g. "payment successful")."""# Send the invoice, collect the money, send the notification (the callback)return {"msg": "Invoice received"}

启动服务

uvicorn callback:app --reload

测试

curl命令:

curl -X 'POST' \'http://127.0.0.1:8000/invoices/?callback_url=http%3A%2F%2Fwww.quye.com' \-H 'accept: application/json' \-H 'Content-Type: application/json' \-d '{"id": "string","title": "string","customer": "string","total": 0
}'

返回信息:

{"msg":"Invoice received"}

证明回调成功。若回调失败,会给出更详细的信息:

{"detail":[{"type":"url_parsing","loc":["query","callback_url"],"msg":"Input should be a valid URL, relative URL without a base","input":"quye.com","ctx":{"error":"relative URL without a base"}}]}

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

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

深入解析语音识别中的关键技术:GMM、HMM、DNN和语言模型

目录 一、高斯混合模型(GMM)与期望最大化(EM)算法二、隐马尔可夫模型(HMM)三、深度神经网络(DNN)四、语言模型(LM)五、ASR系统的整体工作流程结论 在现代语音…

如何将现有VUE项目所有包更新到最新稳定版

更新有风险,Enter要谨慎!!! 要将项目中的所有 npm 包更新到最新稳定版,可以使用 npm-check-updates 工具。以下是具体步骤: 步骤一:安装 npm-check-updates 首先,全局安装 npm-check-updates 工具: npm install -g…

如何使用 C# 编写一个修改文件时间属性的小工具?

下面是简鹿办公一个用 C# 编写的简单工具,它可以批量修改文件的创建时间、最后访问时间和最后修改时间。我们将使用 .NET Framework 或 .NET Core 来实现这个功能。 完整示例代码 1. 创建一个新的 C# 控制台应用程序 您可以使用 Visual Studio 或 .NET CLI 创建一个…

使用PyQt5设计一个简易计算器

目录 设计UI图 代码 结果展示 设计UI图 代码 from PyQt5 import QtCore, QtGui, QtWidgets from PyQt5.QtCore import * from PyQt5.QtGui import * from PyQt5.QtWidgets import QFileDialog, QMainWindow, QMessageBox from untitled import Ui_MainWindow import sysclass…

音频模型介绍

在处理音频数据方面,有多种模型表现出色,它们在不同的音频处理任务上有着各自的优势: 自动编码器:包括多通道变分自动编码器、自回归模型和生成对抗网络等,这些模型在音乐生成领域取得了令人印象深刻的成果。 深度生成…

云计算基础:AWS入门指南

💓 博客主页:瑕疵的CSDN主页 📝 Gitee主页:瑕疵的gitee主页 ⏩ 文章专栏:《热点资讯》 云计算基础:AWS入门指南 云计算基础:AWS入门指南 云计算基础:AWS入门指南 引言 AWS概述 什么…

动态规划-两个数组的dp问题——712.两个字符串的最小ASCII删除和

1.题目解析 题目来源 712.两个字符串的最小ASCII删除和——力扣 测试用例 2.算法原理 1.状态表示 由于如果直接求本题会发现无从下手,不妨根据正难则反的原理,反向求公共子序列的ASCII码最大值即可,于是就转化为求公共子序列的问题&#x…

elementui中的新增弹窗在新增数据成功后再新增 发现数据无法清除解决方法

elementui中的新增弹窗在新增数据成功后再新增 发现数据无法清除解决方法 试过网上其他方法,发现表单清空数据还是有问题,索性用下面方法解决: // 给弹框里面添加 v-ifvisible测试无问题,暂时先这样解决,如果有其他方法&#x…

python 天气数据可视化

Python爬取天气数据及可视化分析 https://blog.csdn.net/weixin_69423932/article/details/135184643

基于Arduino的RGB灯按键控制

一.简介 通过按键控制RGB灯分别显示7种颜色:红 、绿、 蓝、 黄、 青、 紫、 白。 二.按键控制RGB灯原理 1)RGB全彩LED: LED由三个颜色分别为:红(Red)、绿(Green)、蓝(Blue)的LED…

非关系型数据库(1)---MongoDB

目录 1.MongoDB 1.MongoDB的特点 2.MongoDB的应用场景 3.MongoDB与MySQL的比较 2.数据库操作 1. 创建数据库 2. 切换数据库 3. 查看所有数据库 4. 查看当前数据库 5. 删除数据库 6. 查看数据库统计信息 7. 备份数据库 8. 恢复数据库 9. 创建用户和授权 10. 删除用…

1. pytorch 中冻结模型参数后参数仍会被调整

问题 self.sgf_net.requires_grad_(False)起初设置 requires_grad(False) 优化器也没有添加sgfnet的模型参数。但是在pylightning框架中,每次推理完模型的参数都会被改变,经过仔细排查发现问题 # self.sgf_net.requires_grad_(False)for param in self.s…

大模型-微调与对齐-人类对齐背景与标准

1、目的 确保大模型的行为与人类价值观、人类真实意图和社会伦理相一致 2、大模型有害行为 无法正确遵循指令生成虚假信息产生有害、有误导性、有偏见的表达 3、评估标准 有用性诚实性无害性 4、更细化的对齐标准 行为对齐:要求AI能够做出符合人类期望的行为…

hive数据查询语法

思维导图 基本查询 基本语法 SELECT [ALL | DISTINCT] 字段名, 字段名, ... FROM 表名 [inner | left outer | right outer | full outer | left semi JOIN 表名 ON 关联条件 ] [WHERE 非聚合条件] [GROUP BY 分组字段名] [HAVING 聚合条件] [ORDER BY 排序字段名 asc | desc…

Docker lmdeploy 快速部署Qwen2.5模型openai接口

启动服务 我已经把模型下载到/data/xiedong/Qwen2.5-72B-Instruct-GPTQ-Int4 所以docker直接启动: docker run --runtime nvidia --gpus device=0 \-p 23333:23333 \--ipc=host -v /data/xiedong:/data/xiedong/ \openmmlab/lmdeploy:latest \lmdeploy serve api_server /d…

前端UniApp面试题及参考答案(100道题)

目录 UniApp 支持哪些平台? UniApp 在不同平台上的表现有何差异? 如何处理 UniApp 中的平台差异? UniApp 项目创建与目录结构 项目创建 目录结构 如何创建一个 UniApp 项目? UniApp 项目的基本目录结构是什么样的? 解释一下 UniApp 中的页面生命周期钩子函数有哪…

前端小知识:我居然没学会用 split 方法?!

小伙伴们,你们会用 JavaScript 的 split 方法吗?最近我才发现,原来我多年来一直没真正掌握它,结果在解题时被卡住了。所以今天,我决定好好整理一下这个方法的用法。 在讨论问题之前,先来看一下 split 的两种…

Java教学新动力:SpringBoot辅助平台

1系统概述 1.1 研究背景 随着计算机技术的发展以及计算机网络的逐渐普及,互联网成为人们查找信息的重要场所,二十一世纪是信息的时代,所以信息的管理显得特别重要。因此,使用计算机来管理教学辅助平台的相关信息成为必然。开发合适…

【Rust Crate之Actix Web(一)】

Rust Crate之Actix Web 什么是Actix Web?Actix Web 入门代码宏展开,看看 #[get("/")] 做了什么Actix Web中的StateActix Web中的scopeActix Web中的extractorsPathQueryJSONURL-encoded form 总结 什么是Actix Web? Actix Web is a poweful &…

VTK知识学习(2)-环境搭建

1、c方案 1.1下载源码编译 官网获取源码。 利用Cmake进行项目构建。 里面要根据实际使用的情况配置相关的模块哟,这个得你自行研究下了。 CMAKEINSTALLPREFIX--这个选项的值表示VTK的安装路径,默认的路径是C:/Program Files/VTK。该选项的值可不作更…