0

0

fastapi 如何让 OpenAPI 文档显示中文且支持 markdown

舞姬之光

舞姬之光

发布时间:2026-01-17 20:15:08

|

379人浏览过

|

来源于php中文网

原创

FastAPI OpenAPI文档支持中文和Markdown需五步:一、初始化时用UTF-8编码设置中文title/description;二、路由函数用三重双引号docstring并启用description_from_docstring;三、Pydantic字段用Field(description=)注入中文Markdown;四、路由装饰器中用summary/description参数覆盖;五、确保/openapi.json中中文未被Unicode转义且前端正确解析。

fastapi 如何让 openapi 文档显示中文且支持 markdown

如果您使用 FastAPI 构建 API,但 OpenAPI 文档中接口描述、参数说明或响应示例显示为英文或纯文本,无法正确渲染中文和 Markdown 格式,则可能是由于文档元数据未正确配置或未启用富文本支持。以下是实现 OpenAPI 文档显示中文且支持 Markdown 渲染的多种方法:

一、在 FastAPI 实例初始化时设置中文标题与描述

FastAPI 默认通过 titledescription 参数注入根级文档元信息,这些字段支持 Unicode 字符和 Markdown 语法(如 **加粗***斜体*、代码块、列表等),但需确保字符串本身为 UTF-8 编码且未被转义。

1、在创建 FastAPI() 实例时,直接传入中文字符串作为 titledescription 参数。

2、在 description 中使用标准 Markdown 语法编写说明,例如换行用空行分隔,标题用 ##,代码块用三个反引号包裹。

3、确保 Python 源文件顶部声明编码:在文件第一行或第二行添加 # -*- coding: utf-8 -*-

二、为每个路由函数添加中文 docstring 并启用 description_from_docstring

FastAPI 可自动将函数的文档字符串(docstring)提取为接口的 description,前提是启用 description_from_docstring=True 配置,并确保 docstring 使用三重双引号包裹且含 Markdown 内容。

1、在定义 @app.get() 等路由装饰器时,在其上方紧邻位置写三重双引号 docstring。

2、docstring 中使用中文撰写,并嵌入 Markdown 元素,如 **请求说明**`application/json`、无序列表以 - 开头。

3、启动应用前,在 FastAPI() 初始化中显式设置 description_from_docstring=True(该参数在较新版本中默认为 True,但仍建议显式声明)。

三、使用 Pydantic v2 的 model_config 设置字段中文注释

当使用 Pydantic 模型(如 BaseModel)定义请求体或响应体时,字段级中文说明不会自动出现在 OpenAPI 中,需通过 model_config 或字段 description 参数注入,且该 description 支持 Markdown。

1、在 Pydantic 模型字段定义中,使用 Field(description="用户昵称,**最多12个汉字**") 显式指定带 Markdown 的描述。

与光AI
与光AI

一站式AI视频工作流创作平台

下载

2、若使用 Pydantic v2,也可在 model_config = ConfigDict(json_schema_extra={...}) 中为字段补充 description 值。

3、确保字段 description 字符串内容为原始中文 Markdown,不经过 HTML 转义或双重编码。

四、自定义 OpenAPI Schema 中的 summary 和 description 字段

FastAPI 允许通过 summarydescription 参数覆盖单个端点的 OpenAPI 属性,这两个参数均支持中文和 Markdown,优先级高于 docstring。

1、在路由装饰器中直接传入 summary="获取用户列表"description="返回分页的用户数据,包含 `id`、`name` 和 `status` 字段。\n\n| 字段 | 类型 | 说明 |\n|------|------|------|\n| `name` | string | **必填**,用户真实姓名 |"

2、注意:多行字符串中换行符需保留,Markdown 表格、代码块等结构必须符合 CommonMark 规范。

3、关键提示:避免在 description 中使用未闭合的反引号或嵌套过深的缩进,否则会导致 Swagger UI 解析失败而显示为空白

五、确保静态资源与前端渲染环境支持 UTF-8 和 Markdown 解析

FastAPI 内置的 Swagger UI 和 ReDoc 均基于 JavaScript 渲染 OpenAPI JSON,其对中文和 Markdown 的支持依赖于 JSON 数据本身的编码正确性及 UI 组件的解析能力。

1、检查生成的 /openapi.json 响应体,确认 info.titlepaths.*.get.description 等字段值为原始中文字符串,而非 Unicode 转义序列(如 \u7528\u6237)。

2、若发现 JSON 中出现 Unicode 转义,需在 FastAPI 初始化时设置 default_response_class=UJSONResponse 并禁用自动转义,或改用标准 JSONResponse 并确保 ensure_ascii=False 已启用(FastAPI 默认已设)。

3、重要验证步骤:直接访问 /openapi.json 查看 raw JSON 输出,确认中文和 Markdown 符号完整可见且未损坏

相关专题

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

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

758

2023.06.15

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

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

639

2023.07.20

python能做什么
python能做什么

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

761

2023.07.25

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

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

618

2023.07.31

python教程
python教程

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

1265

2023.08.03

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

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

548

2023.08.04

python eval
python eval

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

579

2023.08.04

scratch和python区别
scratch和python区别

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

708

2023.08.11

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

43

2026.01.16

热门下载

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

精品课程

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

共58课时 | 3.7万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 2.3万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.9万人学习

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

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