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 的描述。

What-the-Diff
What-the-Diff

检查请求差异,自动生成更改描述

下载

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 符号完整可见且未损坏

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

455

2023.08.07

json是什么
json是什么

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

546

2023.08.23

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

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

334

2023.10.13

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

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

82

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

28

2025.12.22

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

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

251

2026.02.06

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1010

2023.08.02

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

760

2023.08.03

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

3

2026.03.11

热门下载

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

精品课程

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

共58课时 | 6万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 3.4万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.6万人学习

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

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