统一响应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 import status
from fastapi.responses import JSONResponse, Response  # , ORJSONResponse
from typing import Union# 注意有个 * 号 不是笔误， 意思是调用的时候要指定参数 e.g.resp_200（data=xxxx)
def resp_200(*, data: Union[list, dict, str]) -> Response:return JSONResponse(status_code=status.HTTP_200_OK,content={'code': 200,'message': "Success",'data': data,})def resp_400(*, data: str = None, message: str="BAD REQUEST") -> Response:return JSONResponse(status_code=status.HTTP_400_BAD_REQUEST,content={'code': 400,'message': message,'data': data,})# 所有响应状态都封装在这里
xxxx

调用

调用就很简单了, 导入调用就行了。

from api.utils import response_code@router.get("/table/list")
async def get_table_list():return response_code.resp_200(data={"items":  ["xx", "xx"]})

一些补充

我上面用的序列化的工具方法JSONResponse 是框架自带的，作者还在文档里面补充说明了，如何调用其他的序列化方法，更快的去序列化json数据。
如 ORJSONResponse UJSONResponse 等方法
这些是要在额外安装依赖库的

可以参见文档
https://fastapi.tiangolo.com/advanced/custom-response/#ujsonresponse

本文GitHub地址

见个人博客: https://www.charmcode.cn/article/2020-07-16_fastapi_response_json

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

【FastAPI后台API 八】JWT token认证登陆
JWT token认证登陆前一篇博客讲述了获取和验证请求参数, 这一篇就实践下,演示一个最基础的JWT认证,我公司是用了两个token方式验证,一个请求token,一个刷新token,请求token ...
SpringBoot入门系列（二）如何返回统一的Json数据格式
前面介绍了Spring Boot的优点,然后介绍了如何快速创建Spring Boot 项目.不清楚的朋友可以看看之前的文章: https://www.cnblogs.com/zhangweizhong ...
百度搜索排名API接口PC返回JSON数据格式
百度搜索排名API接口返回JSON数据格式写个笔记, 记录一下 https://www.baidu.com/s?wd=新信息&pn=50&rn=50&tn=json 参数说明 ...
【FastAPI后台API 一】配置文件(移步博客园或个人网站)
FastAPI 配置文件准备使用Vue + FastAPI开发一套后台管理系统,记录自己使用FastAPI的技术点. 移步博客园 https://www.cnblogs.com/CharmCode/ ...
后台怎么接收处理从url 客户端传来的json数据格式
最近做项目用到了一个新的客户端传参的方式,主要采用的是客户端以json数据格式的方式想后台传递数据,所以,后台接收的参数也是json格式的,刚开始不知道怎么做, 到最后才找到了解决的办法就是利用go ...
怎么把json数据转化为数组_RESTful API 返回统一JSON数据格式是怎么实现的？
关于 Spring 的全局处理,我有两方面要说: 统一数据返回格式统一异常处理为了将两个问题说明清楚,将分两个章节分别说明,本章主要说第一点有童鞋说,我们项目都做了这种处理,就是在每个 API ...
springMVC02-SSM整合（Result统一响应数据格式、异常页面修改、SSM整合vue-elementUI小案例、SpringMVC的拦截器Interceptor）
文章目录今日内容一.SSM整合[重点] 1 SSM整合配置问题导入 1.1 SSM整合流程 1.2 SSM整合配置 1.2.1 创建工程,添加依赖和插件 1.2.2 Spring整合Mybati ...
Spring Boot 无侵入式实现API接口统一JSON格式返回
作者 | 小魏小魏我们去那里呀来源 | blog.csdn.net/qq_34347620/article/details/102239179 无侵入式统一返回JSON格式其实本没有没打算写这篇 ...
Spring Boot 无侵入式实现 API 接口统一 JSON 格式返回
点击上方蓝色"方志朋",选择"设为星标" 回复"666"获取独家整理的学习资料! 无侵入式统一返回JSON格式其实本没有没打算写这篇博客 ...

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