Python FastAPI怎么生成文档_Swagger UI与ReDoc自动接口文档

大辰酱_7725

大辰酱_7725

2026-05-26

620人浏览

原创

fastapi默认内置swagger ui和redoc文档界面,分别位于/docs和/redoc路径,依赖动态生成的/openapi.json;禁用路径不等于隐藏api契约,需谨慎配置中间件与环境判断。

python fastapi怎么生成文档_swagger ui与redoc自动接口文档

FastAPI 默认就带 Swagger UI,不用额外装包

只要用 FastAPI() 实例启动服务,默认在 /docs 路径就能打开 Swagger UI。它不是“生成静态 HTML”,而是运行时动态渲染的交互式文档——所以没配好路由或没跑服务,就打不开页面。

  • 确保 app = FastAPI() 没加 docs_url=None 或 redoc_url=None 这类禁用参数
  • 开发环境默认开启;生产部署时如果用了反向代理(比如 Nginx),要确认 /docs 和 /redoc 路径没被拦截或重写
  • Swagger UI 依赖 /openapi.json 接口返回标准 OpenAPI v3 JSON,这个接口不能被中间件过滤或鉴权拦住

ReDoc 页面在 /redoc,但不支持所有 OpenAPI 扩展字段

ReDoc 是另一个内置文档界面,路径是 /redoc,视觉更简洁、适合嵌入文档站。但它对某些 FastAPI 自动生成的字段兼容性较弱,比如带 examples 或自定义 response_model_exclude_unset=True 的接口,可能显示为空响应体或丢失示例值。

  • 若发现 ReDoc 里响应结构缺失,先检查模型字段是否加了 Field(default=...) 或 Optional 声明不明确
  • ReDoc 不识别 deprecated=True 的接口标记,Swagger UI 可以——需要标注弃用时优先看 Swagger
  • 想换掉默认路径?可以初始化时改: FastAPI(redoc_url="/api/docs"),但别设成和 /docs 冲突

OpenAPI JSON 是文档源头,改它等于改所有界面

/openapi.json 是 Swagger UI 和 ReDoc 共用的数据源,FastAPI 自动生成它。如果你手动改了 app.openapi() 方法,或者用中间件篡改了该路径响应,两个界面都会同步出问题。

361SCAN security check your skill python scripts
361SCAN security check your skill python scripts

扫描并分析已安装技能,用于查看指定技能目录的名称、描述和详情,或列出所有已安装的技能。

下载
  • 常见错误:在中间件里对所有 JSON 响应统一加 {"data": ...} 包裹,结果把 /openapi.json 也包了,导致 UI 加载失败并报错 Failed to load spec
  • 想定制 OpenAPI 内容?用 app.openapi_schema 缓存 + 条件重建,而不是覆盖 app.openapi 方法
  • 加全局 tags、servers、externalDocs?直接传给 FastAPI() 初始化参数,比后期 patch 更稳

关闭文档只关路径,不删 OpenAPI 数据

设 docs_url=None 只是让 /docs 返回 404,并不会影响 /openapi.json 输出。很多团队误以为“关了 docs 就安全了”,其实攻击者仍可拿到完整接口定义。

  • 真要隐藏接口契约?得同时禁用 openapi_url=None,但这会让所有文档界面彻底失效(包括自己调试)
  • 更实际的做法:用中间件对 /openapi.json 做环境判断,比如只在 DEBUG=True 时返回内容
  • 注意:redoc_url=None 和 docs_url=None 互不影响,可以只留一个

真正容易被忽略的是 OpenAPI JSON 的生成时机——它首次访问 /openapi.json 才构建,期间若模型引用了还没 import 的模块,会直接 500。所以文档路径看似“自动”,背后仍卡在代码加载顺序上。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1751

4

python能做什么
python能做什么

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

2023.07.25

4544

7

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

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

2023.07.31

1729

3

python教程
python教程

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

2023.08.03

26837

23

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

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

2023.08.04

3247

5

python eval
python eval

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

2023.08.04

3267

5

scratch和python区别
scratch和python区别

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

2023.08.11

1183

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2523

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习