讲师中心 微信公众号

工具推荐

视频效率加速
Seko
Seko

AI短剧一键生成成片

AniShort
AniShort

AI短剧协同制作平台

Laper
Laper

剧本策划到成片协作

剧云
剧云

中文短剧剧本制作平台

FastAPI怎么汉化Swagger UI和Redoc文档页面

星晨姑娘_2520

星晨姑娘_2520

发布时间:2026-11-09 11:01:31

|

802人浏览过

|

来源于php中文网

原创

FastAPI的Swagger UI和ReDoc中文支持靠前端配置而非后端翻译:Swagger UI 5.x+需在swagger_ui_parameters中显式设"layout":"BaseLayout"及"lang":"zh-cn";ReDoc需URL加?lang=zh;推荐本地化静态资源避免CDN失败。

fastapi怎么汉化swagger ui和redoc文档页面

FastAPI 的 Swagger UI 和 ReDoc 默认是英文界面,但它们本身支持多语言——关键不是改 FastAPI 代码,而是往 swagger_ui_parameters 或 redoc_url 对应的前端资源里注入语言配置。国内开发者常误以为要“翻译模板”或“重写 HTML”,其实只要配对参数、加载对应语言包,就能生效。

Swagger UI 怎么启用中文(含版本兼容要点)

Swagger UI 5.x+ 内置中文支持,靠的是 swagger_ui_parameters 中的 layout 和 presets 配合语言标识。不加配置时它会按浏览器 Accept-Language 自动 fallback,但在国内常因 CDN 加载失败或未显式声明导致仍显示英文。

  • 必须显式设置 "layout": "BaseLayout",否则中文 label 可能不渲染
  • 加上 "defaultModelRendering": "model" 和 "docExpansion": "list" 能避免模型折叠后中文字段名被截断
  • 关键语言参数:在 swagger_ui_parameters 里加 "supportedSubmitMethods": ["get","post","put","delete","patch"](部分旧版 UI 会因缺失该字段跳过 i18n 初始化)
  • 如果你用的是 Swagger UI https://cdn.jsdelivr.net/npm/swagger-ui-dist@4.15.5/swagger-ui-bundle.js 并补上 lang: "zh-cn" 参数——但更推荐升级 FastAPI + 改用本地化方案,避免 CDN 不稳定

Redoc 怎么强制中文显示

ReDoc 的多语言支持比 Swagger UI 更隐蔽:它不依赖 Accept-Language,也不暴露 lang 参数,而是靠加载时 URL 的 hash 或 query string 控制。直接访问 /redoc 通常不会触发中文,除非你主动传参。

FastAPI Flask Proxy
FastAPI Flask Proxy

FastAPI + Flask 混合部署最佳实践,解决路由定义、API 代理等常见问题,适用于同时运行 FastAPI API 与 Flask 前端的场景。

下载
  • 最简单有效的方式:把 Redoc 页面 URL 改成 /redoc?lang=zh,它会自动加载内置中文文案(ReDoc v2.0+ 均支持)
  • 若想默认就走中文,初始化 FastAPI 时不要只改路径,要配合中间件重定向:
    from fastapi import Request, Response
    from starlette.middleware.base import BaseHTTPMiddleware
    
    class RedocLangMiddleware(BaseHTTPMiddleware):
        async def dispatch(self, request: Request, call_next):
            if request.url.path == "/redoc" and not request.url.query:
                return Response(status_code=302, headers={"Location": "/redoc?lang=zh"})
            return await call_next(request)
    
  • 注意:ReDoc 的中文翻译覆盖不如 Swagger UI 全,比如 deprecated 字段、examples 区域的提示语可能仍是英文,这是它的已知限制,不是配置问题

为什么本地化静态资源能彻底解决汉化+加载失败问题

单纯配参数治标不治本。国内访问 cdn.jsdelivr.net 经常超时或 403,导致 Swagger UI/ReDoc 的 JS 文件加载失败,整个文档页白屏——这时候即使写了 lang="zh" 也根本跑不起来。

  • 真正可靠的方案是:下载官方发布的 swagger-ui-bundle.js 和 redoc.standalone.js,放进项目 static/ 目录,再通过 FastAPI 的 app.mount() 暴露静态路由
  • 然后在初始化时指定本地路径:
    app = FastAPI(
        docs_url=None,
        redoc_url=None,
    )
    app.mount("/static/swagger", StaticFiles(directory="static/swagger-ui"), name="swagger")
    app.mount("/static/redoc", StaticFiles(directory="static/redoc"), name="redoc")
    
  • 接着自定义路由返回 HTML,在页面里用 <script src="/static/swagger/swagger-ui-bundle.js"></script> 加载,并传入 lang: "zh-cn";Redoc 同理,URL 末尾拼 ?lang=zh
  • 这个做法绕过了所有 CDN 依赖,也让你完全掌控语言包版本——比如 Swagger UI v5.17.10 的中文翻译比 v5.9.0 准确得多,而 FastAPI 默认绑的是老版本

最容易被忽略的一点:OpenAPI JSON 本身不含语言信息,所有汉化都发生在前端 JS 渲染层。所以改 title、description 这些字段只能影响文档头部,接口参数名、响应字段说明是否中文,取决于你用的 Swagger UI / ReDoc 版本及其内置翻译完整性,而不是 FastAPI 的 Python 代码。

热门AI工具

更多
WorkBuddy

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

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

咔片AIPPT

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

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

豆包大模型

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

二狗PPT
二狗PPT Hot

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

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

DeepSeek

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

相关专题

更多
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 构建高效、可扩展的微服务应用,提高服务响应速度与系统可维护性。

574

2026.02.06

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

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

736

2026.05.09

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

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

619

2026.06.16

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

20

2026.11.06

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

20

2026.11.06

Postman接口请求发送教程
Postman接口请求发送教程

详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。

20

2026.11.06

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

40

2026.11.05

DBeaver安全防护教程大全
DBeaver安全防护教程大全

DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。

20

2026.11.05

热门下载

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

精品课程

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

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