0

0

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

舞姬之光

舞姬之光

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

|

309人浏览过

|

来源于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

一点PPT
一点PPT

一句话生成专业PPT,AI自动排版配图

下载
  • 无需额外操作,保持原样返回即可
  • 若需自定义 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"}

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

457

2023.08.07

json是什么
json是什么

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

549

2023.08.23

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

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

337

2023.10.13

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

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

82

2025.09.10

Python FastAPI异步API开发_Python怎么用FastAPI构建异步API
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API

Python FastAPI 异步开发利用 async/await 关键字,通过定义异步视图函数、使用异步数据库库 (如 databases)、异步 HTTP 客户端 (如 httpx),并结合后台任务队列(如 Celery)和异步依赖项,实现高效的 I/O 密集型 API,显著提升吞吐量和响应速度,尤其适用于处理数据库查询、网络请求等耗时操作,无需阻塞主线程。

28

2025.12.22

Python 微服务架构与 FastAPI 框架
Python 微服务架构与 FastAPI 框架

本专题系统讲解 Python 微服务架构设计与 FastAPI 框架应用,涵盖 FastAPI 的快速开发、路由与依赖注入、数据模型验证、API 文档自动生成、OAuth2 与 JWT 身份验证、异步支持、部署与扩展等。通过实际案例,帮助学习者掌握 使用 FastAPI 构建高效、可扩展的微服务应用,提高服务响应速度与系统可维护性。

251

2026.02.06

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

887

2023.07.31

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

463

2024.06.27

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

26

2026.03.13

热门下载

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

精品课程

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

共46课时 | 3.6万人学习

AngularJS教程
AngularJS教程

共24课时 | 4.2万人学习

CSS教程
CSS教程

共754课时 | 42.9万人学习

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

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