FastAPI（46）- JSONResponse-阿里云开发者社区

FastAPI（46）- JSONResponse

2022-05-15 293

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： FastAPI（46）- JSONResponse

背景

创建 FastAPI 路径操作函数时，通常可以从中返回任何数据：字典、列表、Pydantic 模型、数据库模型等
默认情况下，FastAPI 会使用 jsonable_encoder 自动将该返回值转换为 JSON 字符串
然后，FastAPI 会将与 JSON 兼容的数据（例如 dict）放在 JSONResponse 中，然后将 JSONResponse 返回给客户端
总结：默认情况下，FastAPI 将使用 JSONResponse 返回响应
但是可以直接从路径操作函数中返回自定义的 JSONResponse

返回响应数据的常见方式（基础版）

https://www.cnblogs.com/poloyy/p/15364635.html

最简单的栗子

路径操作函数返回一个 Pydantic Model

#!usr/bin/env python
# -*- coding:utf-8 _*-
"""
# author: 小菠萝测试笔记
# blog:  https://www.cnblogs.com/poloyy/
# time: 2021/10/3 3:26 下午
# file: 38_responses.py
"""
from typing import Optional
import uvicorn
from fastapi import FastAPI
from fastapi.encoders import jsonable_encoder
from fastapi.responses import JSONResponse
from pydantic import BaseModel
app = FastAPI()
class Item(BaseModel):
    id: str
    name: str
    title: Optional[str] = None
@app.post("/item")
async def get_item(item: Item):
    # 打印看看传进来的数据是什么
    print(item, type(item))
    # 直接返回传进来的数据
    return item
if __name__ == '__main__':
    uvicorn.run(app="38_responses:app", reload=True, host="127.0.0.1", port=8080)

正常传参的请求结果

Response Header 的显示 content-type 是 JSON

console 打印结果

id='string' name='string' title='string' <class'38_responses.Item'>

INFO: 127.0.0.1:51856 - "POST /item HTTP/1.1" 200 OK

item 类型的确是 Pydantic Model 类
但最终返回给客户端的是一个 JSON 数据

等价写法

@app.post("/item")

async def get_item(item: Item):

return item

这样写也能返回 JSON 数据，是因为FastAPI 是自动帮忙做了转换的

等价写法如下

from fastapi.encoders import jsonable_encoder

@app.post("/item")

async def get_item(item: Item):

json_body = jsonable_encoder(item)

return JSONResponse(content=json_body)

打印数据，来看看细节

@app.post("/item2")
async def get_item(item: Item):
    json_body = jsonable_encoder(item)
    print(json_body, type(json_body))
    return JSONResponse(content=json_body)