如何在 FastAPI 中返回纯字符串列表作为响应?

陌明同学_4736

陌明同学_4736

2026-05-09

527人浏览

原创

如何在 FastAPI 中返回纯字符串列表作为响应?

fastapi 默认按 pydantic 模型结构序列化响应,若需返回形如 {"tags": ["t1", "t2", "t3"]} 的扁平字符串列表(而非对象列表),应避免使用嵌套模型,改用基础类型(如 dict 或 list[str])作为 response_model,并在逻辑中直接提取字段值。

fastapi 默认按 pydantic 模型结构序列化响应,若需返回形如 {"tags": ["t1", "t2", "t3"]} 的扁平字符串列表(而非对象列表),应避免使用嵌套模型,改用基础类型(如 dict 或 list[str])作为 response_model,并在逻辑中直接提取字段值。

在 FastAPI 中,response_model 不仅用于文档生成(OpenAPI),更严格控制响应体的序列化结构与类型校验。你当前定义的 TagList 模型要求 tags 字段为 List[Tag],因此即使数据库只查出 name 字符串,FastAPI 仍会尝试将其构造成 Tag 实例(触发 from_attributes=True),最终输出带 {"name": "t1"} 的对象数组。

要获得目标格式 {"tags": ["t1", "t2", "t3"]},关键在于两点:
✅ 响应模型精简:不再使用 TagList,而采用 Dict[str, List[str]] 或更推荐的 Annotated[Dict[str, List[str]], ...];
✅ 数据提取精准:从 SQL 查询结果中直接取 name 字段的字符串值,而非构造 Tag 对象。

以下是优化后的端点实现:

from typing import Dict, List
from fastapi import APIRouter, Depends
from sqlalchemy.orm import Session
from sqlalchemy import text

router = APIRouter()

@router.get(
    "/tags",
    response_model=Dict[str, List[str]],  # 明确声明返回结构:键为 str,值为字符串列表
    status_code=200
)
def read_tags(db: Session = Depends(get_session)):
    with db as session:
        result = session.execute(text("SELECT name FROM tags"))
        # 直接提取每行的第一个字段(即 name),转为字符串列表
        tag_names = [row[0] for row in result]
    return {"tags": tag_names}

⚠️ 注意事项:

  • 若坚持使用 response_model=TagList,则必须让 Tag 模型的 nome 字段与数据库列名 name 一致(当前为 nome ≠ name),或在查询中显式别名:SELECT name AS nome FROM tags;但此方式仍会返回对象数组,不符合需求。
  • 使用 response_model=dict(如原答案所示)虽能绕过校验,但牺牲了 OpenAPI 文档的准确性与类型提示,不推荐生产环境使用。
  • 更佳实践是定义精准的响应模型,例如:
    from pydantic import BaseModel
    class TagNameResponse(BaseModel):
        tags: List[str]
    # 然后设置 response_model=TagNameResponse

总结:FastAPI 的响应结构由 response_model 主导,而非返回字典的键名。始终让模型定义与预期 JSON 结构严格对齐,并在业务逻辑中做好数据清洗——这是实现简洁、可维护、自文档化 API 的核心原则。

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

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1871

4

python能做什么
python能做什么

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

2023.07.25

5064

7

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

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

2023.07.31

1809

3

python教程
python教程

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

2023.08.03

30537

23

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

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

2023.08.04

3627

5

python eval
python eval

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

2023.08.04

3647

5

scratch和python区别
scratch和python区别

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

2023.08.11

1243

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

616

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2823

5

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习