【FastAPI后台API 五】统一响应json数据格式

最新推荐文章于 2025-10-05 03:24:48 发布
原创 最新推荐文章于 2025-10-05 03:24:48 发布 · 5.7k 阅读 · 10 ·
CC 4.0 BY-SA版权
更多博文在我的个人网站 https://www.charmcode.cn
文章标签：

#python

本文详细介绍了前后端分离项目中，统一响应JSON数据格式的设计与实现。包括响应格式的组成、状态码约定、数据和消息字段说明。同时，分享了使用FastAPI框架下，如何通过response_code.py文件封装响应数据格式，以及如何调用这些封装好的响应格式。

统一响应json数据格式

本系列博客是配合Vue开发一套后台管理系统，对应的Vue教程见个人博客

https://www.charmcode.cn/

现在了很多项目，都是前后端分离的项目，所以了前后端都会约定传输的数据格式，以及响应提醒。

响应json格式

现在应该都是使用的json交互了，应该没有使用xml的吧？
一般了响应json格式是由以下三个字段组成。

{
   
   
 "code": 200,   // 统一成功状态码 前后端约定 有的是0 有的是20000
 "data": xxx,   // 可以是任意类型数据 有接口文档对接
 "message": "success"  // 消息提示，是状态码的简要补充说明
}

前端一般都会做个响应拦截处理，如果状态码不是约定成功的状态码就拦截，然后提示message里面的消息，是的话就返回data里面的数据。

封装响应格式

我在utils/response_code.py 工具文件夹下，创建了一个response_code.py文件
专门存放封装的响应数据格式。

from fastapi
最低0.47元/天 解锁文章
FastAPI 学习之路（五十九）封装统一的json返回处理工具
mr~li的博客
07-18 1470
在本篇文章之前的接口，我们每个接口异常返回的数据格式都不一样，处理起来也没有那么方便，因此我们可以封装一个统一的json。改造后，我们的返回消息，可以自定义code，message，data。接下来我们再次改造下我们的新建用户的接口。把代码统一放到common下面的json_tools.py里面，我们在接口返回的时候调用。这样我们就完成了统一接口响应处理，后续我们可以在所有的接口中使用。我们看下修改后的用户返回。我们看下处理后的效果。我们看创建重复的返回。
FastAPI(六)统一返回值
热门推荐
Good Luck
02-13 1万+
FastAPI(六)统一返回值
python fastapi统一捕获请求和响应
weixin_45592677的博客
05-26 324
3f。
FastAPI自定义异常：统一错误响应格式
最新发布
gitblog_00280的博客
10-05 890
你是否遇到过FastAPI接口返回的错误格式杂乱无章？不同异常返回不同结构，前端处理起来十分麻烦？本文将介绍如何在FastAPI项目中实现统一的错误响应格式，让你的API更加专业和易用。 读完本文，你将学会： - 如何自定义异常类 - 如何全局捕获并处理异常 - 如何返回统一格式的错误响应 - 如何在依赖项中使用自定义异常 ## 为什么需要统一错误响应格式 在开发API时，统一的错误响应格式...
10.FastAPI响应体
chenhaiy的博客
01-14 1047
10.FastAPI响应体 FastAPI支持声明响应体模型进行响应数据的处理。 可以在任意路由操作中使用 response_model 参数来声明用于响应的模型： @app.get() @app.post() @app.put() @app.delete() 等等。 response_model是装饰器方法（get，post 等）的一个参数，而不是路由操作函数的参数；其类型与 Pydantic 模型属性所声明的类型相同，因此它可以是一个 Pydantic
FastAPI 统一接口响应（Json）模板的使用示例
Franciz777的博客
01-02 1741
在 FastAPI 项目中，通常需要对所有接口的响应进行统一封装，以便于前端或调用方能够一致地处理响应数据。这里只是介绍一种基于不同端口（不同的前端）使fastapi返回不停格式的json响应的使用场景，下面为具体实现的步骤，可以根据实现原理自己修改适配不同的场景。会自动对返回的 JSON 响应进行包装，所有符合条件的请求都会按照统一格式返回响应。方法中添加日志记录，跟踪请求的处理时间，记录请求的 URL、参数以及响应的状态码。，则提取响应体内容，并构建一个标准的响应格式。），则进行统一响应格式的处理。
FastAPI 封装一个通用的response
weixin_43632687的博客
07-27 1356
fastapi 封装response
【FastAPI】使用 FastAPI 实现后台多任务（BackgroundTasks和Celery两种方案）
h1773655323的博客
09-29 5234
FastAPI 提供了灵活的异步任务处理能力。对于简单的任务，可以使用内置的，它非常适合单节点的轻量级任务处理。如果你的应用需要更复杂的任务调度或者分布式处理，Celery 是一个强大的选择。
fastapi_No.7_获取表单和文件数据
Ethan's Blog
10-15 2977
主要讲述了如何通过fastapi获取表单数据和文件
Ruby Fast JSON API序列化器高效处理JSON数据
Fast JSON API 是一个专为 Ruby 语言设计的高性能 JSON:API 序列化器，旨在高效地将 Ruby 对象转换为符合 JSON:API 规范的数据格式。该项目最初由 Netflix 开源，目标是解决在构建大规模 API 服务时常见的性能瓶颈...
基于FastAPI和SQLite的权限管理系统
06-11
FastAPI提供了一些内置支持，如JWT（JSON Web Tokens）用于身份验证，然后可以基于用户角色或权限进行授权。 6. **路由与中间件**: FastAPI通过装饰器定义路由，比如`@app.get()`、`@app.post()`等，它们将HTTP请求...
fastapi-jwt：通过使用JSON Web令牌（JWT）启用身份验证来保护FastAPI应用程序
02-16
使用基于JWT令牌的身份验证保护FastAPI 是否想学习如何构建？ 查看。 要使用这个项目吗？ 货叉/克隆 创建并激活虚拟环境： $ python3 -m venv venv && source venv/bin/activate 安装要求： (venv)$ pip install -r requirements.txt 运行应用程序： (venv)$ python main.py 在
fastapi-jsonrpc:基于fastapi的JSON-RPC服务器
05-25
描述 基于fastapi的JSON-RPC服务器： 动机 自动生成的JSON-RPC的OpenAPI和Swagger （感谢fastapi）！！！ 安装 pip install fastapi-jsonrpc 文献资料 阅读FastAPI文档，并在下面查看用法示例 简单用法示例 pip install uvicorn example1.py import fastapi_jsonrpc as jsonrpc from pydantic import BaseModel from fastapi import Body app = jsonrpc . API () api_v1 = jsonrpc . Entrypoint ( '/api/v1/jsonrpc' ) class MyError ( jsonrpc . BaseError ): CODE = 5000 M
python+fastAPI统一封装返回值（已测试可用）
jingyucsdn的博客
06-16 579
response.body_iterator = iter([body]) # 重置迭代器。response.body_iterator = iter([body]) # 重置迭代器。body_data = body.decode() # 非JSON则保留原始数据。body_data = body.decode() # 非JSON则保留原始数据。frame.f_code.co_name == 'dispatch' # 常见中间件入口方法。如果想过滤掉其中的某个路径信息，可以这样写。
在 FastAPI 项目中使用 Python 注解类型实现通用返回结构
li_yatao的博客
08-11 1015
在开发 API 时，确保一致的响应结构是一个良好的实践。无论是前端开发人员还是后端开发人员，都希望能够依赖一个统一的返回格式，这样可以简化调试和处理逻辑。在这篇文章中，我们将探讨如何在 FastAPI 项目中使用 Python 的注解类型和pydantic模块来实现一个通用的返回结构。为了实现一个统一的响应结构，我们首先需要定义一个通用的响应模型。在 Python 中，我们可以使用pydantic的BaseModel来实现这个结构。
FastAPI学习-6.POST请求 JSON 格式 body
qq_27371025的博客
03-13 6564
前言 post请求接收json格式请求body 创建数据模型 从 pydantic 中导入 BaseModel， 将你的数据模型声明为继承自 BaseModel 的类。 from typing import Optional from fastapi import FastAPI from pydantic import BaseModel class Item(BaseModel): name: str description: Optional[str] = None pr
【FastAPI】利用 typing 泛型实现统一 JSON 返回格式并被 OpenAPI 检测到
VLyb
02-06 3722
假设我们在使用 FastAPI 构建 RESTful 服务时要返回一个 User 对象的数据，同时又想实现统一的返回格式，我们可能这样做： from pydantic import BaseModel from typing import Any class RestfulModel(BaseModel): code: int msg: str data: Any class User(BaseModel): uid: str name: str age: int @app.get('
FastAPI 学习之路（五十二）WebSockets(八)接受/发送json格式消息
mr~li的博客
07-16 1255
前面我们发送的大多数都是text类型的消息，对于text消息来说，后端处理出来要麻烦的多，那么我们可以不可以传递json格式的数据，对于前后端来说都比较友好，答案是肯定的，我们需要做下处理。
fastapi获取微信小程序的json数据并且返回
weixin_59246157的博客
04-13 2079
@app.post`装饰器指定了路由路径`/api/data`和请求方法为POST，当微信小程序通过POST请求发送数据时，就会调用`process_data`函数。函数接受一个`Data`类型的参数，FastAPI会自动将POST请求中传递过来的JSON数据解析为`Data`类型的实例。在FastAPI中，可以使用声明式路由和`pydantic`模块来获取和解析微信小程序传递过来的JSON数据，并返回处理后的结果。对数据进行处理后，我们可以返回一个字典或一个`BaseModel`实例作为响应。
评论 3
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值