FASTAPI系列 14-使用JSONResponse 返回JSON内容

本文主要是介绍FASTAPI系列 14-使用JSONResponse 返回JSON内容，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

FASTAPI系列 14-使用JSONResponse 返回JSON内容

文章目录

FASTAPI系列 14-使用JSONResponse 返回JSON内容
前言
一、默认返回的JSON格式
二、JSONResponse 自定义返回
三、自定义返回 headers 和 media_type
总结

前言

当你创建一个 FastAPI 接口时，可以正常返回以下任意一种数据：dict，list，Pydantic 模型，数据库模型等等。FastAPI 默认会使用 jsonable_encoder 将这些类型的返回值转换成 JSON 格式，默认情况下会以content-type: application/json 格式返回。

在有些情况下，我们需要在路径操作中直接返回Response对象，这样我们能有更多的操作灵活性，比如自定义头headers 信息、自定义Cookie信息等

提示：以下是本篇文章正文内容，下面案例可供参考

一、默认返回的JSON格式

定义一个字典类型，然后fastpai会默认转化成json然后返回

from fastapi import FastAPI
import uvicornapp = FastAPI()@app.get('/users')
def users():user = {"user_name": "Teacher Li","email": "Teacher_Li@qq.com"}return user

当使用get请求时，返回的格式：

HTTP/1.1 200 OK
date: Tue, 25 Mar 2023 10:40:41 GMT
server: uvicorn
content-length: 36
content-type: application/json{"user_name": "Teacher Li","email": "Teacher_Li@qq.com"}

二、JSONResponse 自定义返回

可以使用 from starlette.responses import JSONResponse 定制返回内容，包含响应状态码，响应headers 和响应body；
JSONResponse 继承自 Response 类，部分源码如下：

class JSONResponse(Response):  media_type = "application/json"  def __init__(  self,  content: typing.Any,  status_code: int = 200,  headers: typing.Optional[typing.Dict[str, str]] = None,  media_type: typing.Optional[str] = None,  background: typing.Optional[BackgroundTask] = None,  ) -> None:  super().__init__(content, status_code, headers, media_type, background)

JSONResponse可传参数：

content：响应body内容，str 或者 bytes.
status_code：响应状态码，int类型，默认200.
headers：响应头部，dict类型.
media_type：media type. 例如"text/html".
background：后台任务

自定义 JSONResponse 响应， status_code 可以自定义状态码，FastAPI 会自动包含 Content-Length，以及Content-Type，charset等头信息。

from fastapi import FastAPI, status
from fastapi.responses import JSONResponse
import uvicornapp = FastAPI()@app.get('/users')
def users():user = {"user_name": "Teacher Li","email": "Teacher_Li@qq.com"}return JSONResponse(content=user, status_code=status.HTTP_200_OK)

当使用get请求时，返回的格式：

HTTP/1.1 200 OK
date: Tue, 25 Mar 2023 10:40:41 GMT
server: uvicorn
content-length: 36
content-type: application/json{"user_name": "Teacher Li","email": "Teacher_Li@qq.com"}

三、自定义返回 headers 和 media_type

响应头部添加 headers 内容和设置 media_type 响应 body 媒体类型

@app.get('/resp/users')
async def users():user = {"user_name": "Teacher Li", "email": "Teacher_Li@qq.com"}return JSONResponse(content=user,status_code=status.HTTP_201_CREATED,headers={"x-token": "abcdefghijklmnop"},media_type="text/html")

当使用get请求时，返回的格式：

HTTP/1.1 201 Created
date: Tue, 25 Mar 2023 10:40:41 GMT
server: uvicorn
x-token: abcdefghijklmnop
content-length: 36
content-type: text/html{"user_name": "Teacher Li","email": "Teacher_Li@qq.com"}