讲师中心 微信公众号
AI工具推荐 视频效率加速

在FastAPI中返回纯文本响应

秋敏同学_2628

秋敏同学_2628

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

|

436人浏览过

|

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

Claw Code Suite (Python-Only Edition)
Claw Code Suite (Python-Only Edition)

仅使用 Python 将 Claw Code 虚拟化框架与 OpenClaw 集成,提供 184 种工具和 200 多条命令,用于安全分析和代码质量...

下载

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

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

相关专题

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

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

2155

2023.08.07

json是什么
json是什么

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

3342

2023.08.23

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

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

1116

2023.10.13

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

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

3819

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

119

2025.12.22

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

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

554

2026.02.06

Python Web框架FastAPI 全栈开发教程合集
Python Web框架FastAPI 全栈开发教程合集

以 FastAPI 为核心,讲解现代 Python Web API 的高效开发方式,涵盖路由定义与路径参数/查询参数/请求体绑定、Pydantic 模型的数据校验与序列化、依赖注入(Depends)系统的分层设计、中间件与 CORS 配置、OAuth2 + JWT 认证流程、后台任务(BackgroundTasks)、WebSocket 实时通信、SQLAlchemy 异步 ORM 集成、自动生成 OpenAPI/Swagger 交互文

616

2026.05.09

Python FastAPI异步微服务与高性能接口设计
Python FastAPI异步微服务与高性能接口设计

本专题聚焦 Python FastAPI 框架在高性能接口与微服务开发中的应用,讲解异步请求处理、依赖注入机制、路由设计、数据库异步操作以及接口性能优化策略。结合实际项目案例,帮助开发者构建高并发、低延迟的现代化后端服务架构。

519

2026.06.16

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

0

2026.10.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn