0

0

fastapi 如何让单个 endpoint 支持多种响应格式(json/csv)

舞姬之光

舞姬之光

发布时间:2026-01-17 21:13:07

|

289人浏览过

|

来源于php中文网

原创

FastAPI可通过Accept头内容协商实现JSON/CSV多格式响应:匹配"json"或"csv"子串,JSON直接返回Pydantic模型或dict,CSV则用StreamingResponse配合StringIO生成流式响应并设置对应Content-Type及Content-Disposition头。

fastapi 如何让单个 endpoint 支持多种响应格式(json/csv)

FastAPI 本身不直接内置多格式响应(如 JSON/CSV)的自动切换,但可以通过 内容协商(Content Negotiation) —— 即解析请求头中的 Accept 字段,结合手动构造不同响应体来实现。核心思路是:同一个 endpoint 根据客户端期望的格式,返回对应结构的数据(JSON 或 CSV 流),同时设置正确的 Content-TypeContent-Disposition(尤其对 CSV 下载有用)。

1. 基于 Accept 头判断格式

读取 request.headers.get("accept"),粗略匹配 application/jsontext/csv(或通配符 */*)。注意:浏览器通常发 Accept: text/html,application/xhtml+xml...,所以别只依赖精确匹配,可做子串判断或用标准库 email.message.Message 解析更严谨(但多数场景简单判断够用)。

  • 推荐写法:检查 "json" in accept.lower()"csv" in accept.lower()
  • 若未明确指定,可设默认格式(如 JSON),或按业务定优先级

2. 返回 JSON:直接用 Pydantic 模型或 dict

这是 FastAPI 默认行为。只要函数返回一个可序列化的对象(dict、Pydantic model、list),且未显式设置响应类型,FastAPI 自动转为 JSON 并设 Content-Type: application/json

Mistral AI
Mistral AI

Mistral AI被称为“欧洲版的OpenAI”,也是目前欧洲最强的 LLM 大模型平台

下载
  • 无需额外操作,保持原样返回即可
  • 若需自定义 JSON 响应结构(如加 {"data": ...} 包裹),直接 return 字典

3. 返回 CSV:用 StreamingResponse + StringIO

CSV 不适合用普通 JSON 响应,要用 StreamingResponse 流式输出,并设置正确头部:

  • 导入:from fastapi import Responsefrom starlette.responses import StreamingResponse
  • io.StringIO 构建 CSV 内容,再用 StringIO.getvalue().encode("utf-8") 转 bytes
  • 响应 headers 至少包含:{"Content-Type": "text/csv; charset=utf-8"};若希望浏览器下载,加 "Content-Disposition": 'attachment; filename="data.csv"'
  • 示例片段:
import io
import csv
from starlette.responses import StreamingResponse

def generate_csv(data: list[dict]):
    output = io.StringIO()
    if data:
        writer = csv.DictWriter(output, fieldnames=data[0].keys())
        writer.writeheader()
        writer.writerows(data)
    output.seek(0)
    return StreamingResponse(
        iter([output.getvalue().encode("utf-8")]),
        media_type="text/csv; charset=utf-8",
        headers={"Content-Disposition": 'attachment; filename="report.csv"'}
    )

4. 完整 endpoint 示例

把以上逻辑组合进一个路由

  • 接收 query 参数(如 format=json)或仅靠 Accept 头均可;建议两者都支持,更灵活
  • 数据源统一获取(比如从 DB 或 mock),再分支处理格式
  • 注意:CSV 不支持嵌套结构,需扁平化字段(如把 {"user": {"name": "a"}} 展开为 {"user_name": "a"}

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

412

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

533

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

309

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

74

2025.09.10

html版权符号
html版权符号

html版权符号是“©”,可以在html源文件中直接输入或者从word中复制粘贴过来,php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

611

2023.06.14

html在线编辑器
html在线编辑器

html在线编辑器是用于在线编辑的工具,编辑的内容是基于HTML的文档。它经常被应用于留言板留言、论坛发贴、Blog编写日志或等需要用户输入普通HTML的地方,是Web应用的常用模块之一。php中文网为大家带来了html在线编辑器的相关教程、以及相关文章等内容,供大家免费下载使用。

650

2023.06.21

html网页制作
html网页制作

html网页制作是指使用超文本标记语言来设计和创建网页的过程,html是一种标记语言,它使用标记来描述文档结构和语义,并定义了网页中的各种元素和内容的呈现方式。本专题为大家提供html网页制作的相关的文章、下载、课程内容,供大家免费下载体验。

468

2023.07.31

html空格
html空格

html空格是一种用于在网页中添加间隔和对齐文本的特殊字符,被用于在网页中插入额外的空间,以改变元素之间的排列和对齐方式。本专题为大家提供html空格的相关的文章、下载、课程内容,供大家免费下载体验。

245

2023.08.01

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

42

2026.01.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.9万人学习

AngularJS教程
AngularJS教程

共24课时 | 2.7万人学习

CSS教程
CSS教程

共754课时 | 19.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号