返回 FastAPI 中的纯文本

星婷吖_2790

星婷吖_2790

2025-10-29

927人浏览

原创

返回 fastapi 中的纯文本

本文将介绍如何在 FastAPI 应用程序中返回纯文本响应,而不是默认的 JSON 格式。通过使用 `PlainTextResponse`,你可以避免字符串被自动格式化为 JSON,从而直接返回原始文本内容。本文将提供详细的代码示例和步骤,帮助你轻松实现纯文本响应的返回。

FastAPI 默认会将从 endpoint 返回的字符串转换为 JSON 响应。这意味着字符串中的双引号会被转义(加上反斜杠 \),并且整个字符串会被包裹在双引号中。 如果你需要返回未经格式化的纯文本,比如直接返回 Hello "World"! 而不是 "Hello \"World\"!",则需要使用 PlainTextResponse。

使用 PlainTextResponse 返回纯文本

PlainTextResponse 是 FastAPI 提供的响应类,用于返回纯文本内容。要使用它,你需要从 fastapi.responses 导入 PlainTextResponse,并在你的 endpoint 中指定 response_class=PlainTextResponse。

以下是一个示例:

import uvicorn
from fastapi import FastAPI
from fastapi.responses import PlainTextResponse

app = FastAPI()


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


if __name__ == "__main__":
    uvicorn.run(app, host="0.0.0.0", port=8000)

代码解释:

  1. 导入必要的模块:
    • uvicorn:用于运行 FastAPI 应用程序。
    • FastAPI:FastAPI 框架的核心类。
    • PlainTextResponse:用于返回纯文本响应的类。
  2. 创建 FastAPI 实例:
    • app = FastAPI():创建一个 FastAPI 应用程序实例。
  3. 定义 endpoint:
    • @app.get("/", response_class=PlainTextResponse):使用 @app.get() 装饰器定义一个 GET 请求的 endpoint,路径为 /。response_class=PlainTextResponse 指定该 endpoint 返回的响应类型为纯文本。
    • def read_root()::定义 endpoint 的处理函数,该函数返回字符串 'Hello "World"!'。
  4. 运行应用程序:
    • if __name__ == "__main__"::这是一个 Python 惯用法,用于确保只有在直接运行该脚本时才执行以下代码。
    • uvicorn.run(app, host="0.0.0.0", port=8000):使用 uvicorn 运行 FastAPI 应用程序,监听所有 IP 地址(0.0.0.0)的 8000 端口。

运行结果

运行上述代码后,你可以使用浏览器或 curl 等工具访问 http://127.0.0.1:8000/。 你会看到返回的文本是 Hello "World"!,而不会被 JSON 格式化。

JSON Toolkit
JSON Toolkit

JSON文件多功能工具。支持格式化、验证、压缩、键排序及点记法路径查询。零依赖。

下载

注意事项

  • 确保你已经安装了 FastAPI 和 uvicorn:

    pip install fastapi uvicorn
  • PlainTextResponse 适用于返回简单的文本内容。 如果你需要返回更复杂的数据结构,或者需要支持不同的内容类型,则应该使用其他响应类,例如 JSONResponse 或 HTMLResponse。

  • response_class 可以在不同的 endpoint 中灵活使用,根据需要选择合适的响应类型。

总结

通过使用 PlainTextResponse,你可以轻松地在 FastAPI 应用程序中返回纯文本响应。 这在需要返回未经格式化的文本内容时非常有用。 记住,根据你的需求选择合适的响应类型,以确保你的 API 能够正确地处理和返回数据。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关专题

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

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

2023.08.07

2355

5

json是什么
json是什么

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

2023.08.23

3902

1

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

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

2023.10.13

1296

3

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

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

2025.09.10

4539

7

Python FastAPI异步API开发_Python怎么用FastAPI构建异步API
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API

Python FastAPI 异步开发利用 async/await 关键字,通过定义异步视图函数、使用异步数据库库 (如 databases)、异步 HTTP 客户端 (如 httpx),并结合后台任务队列(如 Celery)和异步依赖项,实现高效的 I/O 密集型 API,显著提升吞吐量和响应速度,尤其适用于处理数据库查询、网络请求等耗时操作,无需阻塞主线程。

2025.12.22

119

5

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

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

2026.02.06

594

18

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

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

2026.05.09

776

23

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

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

2026.06.16

659

12

curl_exec
curl_exec

curl_exec函数是PHP cURL函数列表中的一种,它的功能是执行一个cURL会话。给大家总结了一下php curl_exec函数的一些用法实例,这个函数应该在初始化一个cURL会话并且全部的选项都被设置后被调用。他的返回值成功时返回TRUE, 或者在失败时返回FALSE。

2023.06.14

3963

6

热门下载

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

精品课程

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