FastAPI怎样指定非JSON响应的媒体类型

技术文摘

2025-01-09 00:51:20 小编

在使用FastAPI进行Web开发时，默认情况下，响应通常以JSON格式返回。然而，在某些情况下，我们可能需要返回非JSON格式的数据，比如纯文本、XML或者自定义的媒体类型。本文将介绍如何在FastAPI中指定非JSON响应的媒体类型。

我们需要了解FastAPI中的Response类。Response类是FastAPI用于构建响应的基础类，它允许我们自定义响应的各种属性，包括媒体类型。要指定非JSON响应的媒体类型，我们可以在路由处理函数中直接返回一个Response对象，并在构造函数中指定media_type参数。

例如，如果我们想要返回一个纯文本响应，可以这样做：

from fastapi import FastAPI, Response

app = FastAPI()

@app.get("/text")
def get_text():
    content = "这是一个纯文本响应"
    return Response(content=content, media_type="text/plain")

在上述代码中，我们创建了一个名为get_text的路由处理函数，它返回一个包含纯文本内容的Response对象，并将media_type设置为"text/plain"，表示这是一个纯文本响应。

如果我们想要返回XML格式的数据，只需要将media_type设置为"application/xml"，并将XML内容作为Response对象的content参数即可。

除了直接使用Response类，FastAPI还提供了一些方便的辅助函数来返回特定类型的响应。例如，要返回一个HTML页面，可以使用HTMLResponse类：

from fastapi import FastAPI
from fastapi.responses import HTMLResponse

app = FastAPI()

@app.get("/html", response_class=HTMLResponse)
def get_html():
    content = "<html><body><h1>这是一个HTML页面</h1></body></html>"
    return content

在上述代码中，我们通过指定response_class参数为HTMLResponse，告诉FastAPI返回一个HTML响应。

在FastAPI中指定非JSON响应的媒体类型并不复杂。通过使用Response类或相关的辅助函数，我们可以轻松地返回各种类型的响应，满足不同的业务需求。

TAGS: 媒体类型 FastAPI响应非JSON响应 FastAPI技术

万千站长工具

技术文摘

FastAPI怎样指定非JSON响应的媒体类型

欢迎使用万千站长工具！