0

0

在FastAPI中返回纯文本响应

心靈之曲

心靈之曲

发布时间:2025-10-29 11:42:26

|

396人浏览过

|

来源于php中文网

原创

在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)等场景非常有用。

MATLAB 函数帮助文档 中文WORD版
MATLAB 函数帮助文档 中文WORD版

函数是一组语句一起执行任务。在MATLAB中,函数定义在单独的文件。文件函数的文件名应该是相同的。 函数操作在自己的工作空间,它也被称为本地工作区,独立的工作区,在 MATLAB 命令提示符访问,这就是所谓的基础工作区的变量。函数可以接受多个输入参数和可能返回多个输出参数 。 MATLAB是MathWorks公司开发的一种编程语言。它最初是一个矩阵的编程语言,使线性代数编程很简单。它可以运行在交互式会话和作为批处理作业。有需要的朋友可以下载看看

下载

以下是使用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的输出格式,确保内容以纯文本形式直接呈现,避免了不必要的字符转义,从而满足特定的业务需求。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

724

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

628

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

744

2023.07.25

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

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

617

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1236

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

547

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

575

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

702

2023.08.11

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

150

2025.12.31

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 2.7万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.0万人学习

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

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