0

0

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

冷漠man

冷漠man

发布时间:2026-01-20 16:47:29

|

957人浏览过

|

来源于php中文网

原创

FastAPI可通过Accept头或query参数实现单endpoint返回JSON/CVS/XLSX多格式,需匹配Content-Type、Content-Disposition及编码处理。

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

FastAPI 本身不直接内置 CSV 或 XLSX 响应支持,但可以通过 内容协商(Content Negotiation) + 手动构造响应 实现单个 endpoint 返回多种格式(JSON / CSV / XLSX),关键在于识别客户端期望的格式(通过 Accept 请求头或查询参数),然后动态生成对应内容并设置正确 Content-TypeContent-Disposition

1. 基于 Accept 头自动选择格式

这是最符合 REST 规范的方式。客户端在请求头中声明想要的格式:

  • Accept: application/json → 返回 JSON(FastAPI 默认行为)
  • Accept: text/csv → 返回 CSV
  • Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet → 返回 XLSX

在 FastAPI 中,用 Request 获取 accept 头,并按优先级匹配(支持 q= 权重):

示例代码片段:
from fastapi import Request, Response
from fastapi.responses import JSONResponse, PlainTextResponse
from starlette.responses import StreamingResponse
import csv
import io
from openpyxl import Workbook

@app.get("/data") async def get_data(request: Request): accept = request.headers.get("accept", "")

简单解析(生产环境建议用 python-mimeparse 或类似库)

mime_types = [m.split(";")[0].strip() for m in accept.split(",")]

data = [{"name": "Alice", "age": 30}, {"name": "Bob", "age": 25}]

if "application/json" in mime_types:
    return JSONResponse(data)
elif "text/csv" in mime_types:
    output = io.StringIO()
    writer = csv.DictWriter(output, fieldnames=["name", "age"])
    writer.writeheader()
    writer.writerows(data)
    output.seek(0)
    return PlainTextResponse(
        output.getvalue(),
        media_type="text/csv",
        headers={"Content-Disposition": 'attachment; filename="data.csv"'}
    )
elif "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" in mime_types:
    wb = Workbook()
    ws = wb.active
    ws.append(["name", "age"])
    for row in data:
        ws.append([row["name"], row["age"]])
    stream = io.BytesIO()
    wb.save(stream)
    stream.seek(0)
    return StreamingResponse(
        stream,
        media_type="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
        headers={"Content-Disposition": 'attachment; filename="data.xlsx"'}
    )
else:
    return JSONResponse({"error": "Unsupported Accept type"}, status_code=406)

2. 用 query 参数显式指定 format(更简单、更常用)

前端或测试更友好,比如:/data?format=csv。适合快速落地:

甲骨文AI协同平台
甲骨文AI协同平台

专门用于甲骨文研究的革命性平台

下载
  • 定义 format: str = Query("json", regex="^(json|csv|xlsx)$")
  • 统一校验输入,避免 MIME 解析复杂度
  • 便于文档生成(Swagger UI 可交互选择)
推荐写法:
from fastapi import Query

@app.get("/data") def get_data(format: str = Query("json", regex="^(json|csv|xlsx)$")): data = [{"name": "Alice", "age": 30}, {"name": "Bob", "age": 25}]

if format == "json":
    return data  # FastAPI 自动序列化
elif format == "csv":
    output = io.StringIO()
    writer = csv.DictWriter(output, fieldnames=["name", "age"])
    writer.writeheader()
    writer.writerows(data)
    return Response(
        output.getvalue(),
        media_type="text/csv",
        headers={"Content-Disposition": 'attachment; filename="data.csv"'}
    )
elif format == "xlsx":
    wb = Workbook()
    ws = wb.active
    ws.append(["name", "age"])
    for d in data:
        ws.append([d["name"], d["age"]])
    stream = io.BytesIO()
    wb.save(stream)
    stream.seek(0)
    return StreamingResponse(
        stream,
        media_type="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
        headers={"Content-Disposition": 'attachment; filename="data.xlsx"'}
    )

3. 注意事项与优化建议

  • CSV 中文导出需加 BOM:Windows Excel 默认用 GBK 打开无 BOM 的 UTF-8 CSV 会乱码。可在 io.StringIO() 前改用 io.BytesIO() + .encode("utf-8-sig")
  • XLSX 依赖 openpyxl:安装 pip install openpyxl;如需大文件流式写入,考虑 xlsxwriterpyxlsb
  • 性能敏感场景避免内存堆积大数据量时,用 StreamingResponse + 生成器逐行写入 CSV/XLSX,而非全量构建字符串/字节
  • 统一错误处理:格式不支持、数据为空、字段缺失等,建议封装成通用异常处理器返回标准错误响应

4. 可选:用依赖项封装格式逻辑

把格式选择和响应构造抽成依赖项,提升复用性:

from fastapi import Depends

def get_export_response(data: list, format: str): if format == "json": return JSONResponse(data) elif format == "csv":

... 构造 CSV 响应

elif format == "xlsx":
    # ... 构造 XLSX 响应

@app.get("/data") def get_data(format: str = Query("json", regex="^...$")): data = fetch_data() return get_export_response(data, format)

不复杂但容易忽略的是:格式切换不只是“返回不同内容”,更要配对正确的 Content-TypeContent-Disposition 和字符编码处理。只要明确客户端怎么传意图、服务端怎么分发、每种格式怎么安全高效生成,一个 endpoint 支持多格式就非常自然。

相关专题

更多
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的详细内容,可以访问本专题下面的文章。

310

2023.10.13

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

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

75

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,显著提升吞吐量和响应速度,尤其适用于处理数据库查询、网络请求等耗时操作,无需阻塞主线程。

27

2025.12.22

pip安装使用方法
pip安装使用方法

安装步骤:1、确保Python已经正确安装在您的计算机上;2、下载“get-pip.py”脚本;3、按下Win + R键,然后输入cmd并按下Enter键来打开命令行窗口;4、在命令行窗口中,使用cd命令切换到“get-pip.py”所在的目录;5、执行安装命令;6、验证安装结果即可。大家可以访问本专题下的文章,了解pip安装使用方法的更多内容。

339

2023.10.09

更新pip版本
更新pip版本

更新pip版本方法有使用pip自身更新、使用操作系统自带的包管理工具、使用python包管理工具、手动安装最新版本。想了解更多相关的内容,请阅读专题下面的文章。

410

2024.12.20

pip设置清华源
pip设置清华源

设置方法:1、打开终端或命令提示符窗口;2、运行“touch ~/.pip/pip.conf”命令创建一个名为pip的配置文件;3、打开pip.conf文件,然后添加“[global];index-url = https://pypi.tuna.tsinghua.edu.cn/simple”内容,这将把pip的镜像源设置为清华大学的镜像源;4、保存并关闭文件即可。

755

2024.12.23

Java JVM 原理与性能调优实战
Java JVM 原理与性能调优实战

本专题系统讲解 Java 虚拟机(JVM)的核心工作原理与性能调优方法,包括 JVM 内存结构、对象创建与回收流程、垃圾回收器(Serial、CMS、G1、ZGC)对比分析、常见内存泄漏与性能瓶颈排查,以及 JVM 参数调优与监控工具(jstat、jmap、jvisualvm)的实战使用。通过真实案例,帮助学习者掌握 Java 应用在生产环境中的性能分析与优化能力。

6

2026.01.20

热门下载

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

精品课程

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

共162课时 | 12.5万人学习

成为PHP架构师-自制PHP框架
成为PHP架构师-自制PHP框架

共28课时 | 2.4万人学习

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

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