在FastAPI中返回纯文本响应

本文详细介绍了在fastapi应用中如何避免默认的json格式化行为，从而返回未经转义处理的纯文本响应。通过使用`plaintextresponse`对象，开发者可以确保api端点直接输出字符串内容，而不会出现双引号等特殊字符被自动转义的情况，这对于需要精确控制输出格式的场景至关重要。

FastAPI以其高效和便捷的特性广受开发者喜爱。当您在FastAPI的API端点中直接返回一个Python字符串时，框架会默认将其转换为JSON格式的响应。这意味着，如果您的字符串中包含特殊字符，例如双引号（"），FastAPI在将其序列化为JSON时会自动对其进行转义处理，即将"转换为\"。虽然这在大多数情况下是标准且安全的做法，但有时我们可能需要API直接输出未经任何格式化或转义的纯文本内容。

例如，考虑以下FastAPI应用代码：

import uvicorn
from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return 'Hello "World"!'

if __name__ == "__main__":
    uvicorn.run(app)

当运行此应用并通过浏览器或HTTP客户端访问根路径（/）时，您会发现响应内容是"Hello \"World\"!"。原始字符串中的双引号被反斜杠转义，并且整个字符串被包裹在额外的双引号中，这正是标准的JSON字符串表示。如果您的需求是返回一个完全未修改的、与Python字符串字面量完全相同的纯文本，这种默认行为就显得不合时宜。

使用 PlainTextResponse 返回纯文本

为了解决这个问题，FastAPI提供了一个专门的响应类：PlainTextResponse。通过在API端点装饰器中指定response_class=PlainTextResponse，您可以指示FastAPI将响应内容视为纯文本，从而避免任何JSON格式化和字符转义。

PlainTextResponse会确保您的字符串内容直接作为HTTP响应体返回，而不会进行任何额外的处理。这对于需要提供非结构化文本、日志内容、或者特定格式的文本文件（如robots.txt）等场景非常有用。

百度文心百中

百度大模型语义搜索体验中心

22

查看详情

以下是使用PlainTextResponse实现纯文本响应的示例代码：

import uvicorn
from fastapi import FastAPI
from fastapi.responses import PlainTextResponse # 导入 PlainTextResponse

app = FastAPI()

@app.get(
    "/",
    response_class=PlainTextResponse, # 指定响应类为 PlainTextResponse
)
def read_root():
    return 'Hello "World"!'

if __name__ == "__main__":
    uvicorn.run(app)

代码解析：

1. from fastapi.responses import PlainTextResponse: 这一行从fastapi.responses模块中导入了PlainTextResponse类。
2. @app.get("/", response_class=PlainTextResponse,): 在@app.get()装饰器中，我们通过response_class参数明确指定了该端点应使用PlainTextResponse来处理其返回值。
3. def read_root(): return 'Hello "World"!': 端点的逻辑保持不变，依然返回原始的Python字符串。

现在，当您运行修改后的应用并访问根路径时，HTTP响应将直接是Hello "World"!，没有任何额外的引号或转义字符。响应的Content-Type头部也将被设置为text/plain; charset=utf-8，明确表示这是一个纯文本响应。

总结

在FastAPI中，当您需要API端点返回未经处理的原始字符串，而非默认的JSON格式化字符串时，PlainTextResponse是您的理想选择。通过简单地在路由装饰器中设置response_class=PlainTextResponse，您可以精确控制API的输出格式，确保内容以纯文本形式直接呈现，避免了不必要的字符转义，从而满足特定的业务需求。

以上就是在FastAPI中返回纯文本响应的详细内容，更多请关注php中文网其它相关文章！