讲师中心 微信公众号
AI工具推荐 视频效率加速

Python Flask怎么集成Swagger_使用Flasgger一键自动生成并测试交互式在线API文档

大晨吖_4838

大晨吖_4838

发布时间:2026-03-22 02:01:32

|

540人浏览过

|

来源于php中文网

原创

Flasgger需在Flask应用创建且所有蓝图注册完成后初始化,调用flasgger.init_app(app);若提前初始化或蓝图未挂载,会导致swagger.json 404。

python flask怎么集成swagger_使用flasgger一键自动生成并测试交互式在线api文档

Flasgger 装了但 swagger.json 404?检查初始化顺序和蓝图注册

Flasgger 不是装完就自动生效的,它依赖 Flask 应用实例的生命周期。常见错误是把 Flasgger 实例创建得太早,比如在定义 app = Flask(__name__) 之前,或在蓝图未注册前就调用 swagger_ui 路由。

正确做法是:确保 Flasgger 初始化在 app 创建之后、所有路由(尤其是 @app.route 或 blueprint.add_url_rule)注册完成之后。

  • 不要在 __init__.py 中仅声明 flasgger = Flasgger() 就结束;必须调用 flasgger.init_app(app)
  • 如果用了蓝图,确保蓝图已通过 app.register_blueprint() 挂载,再初始化 Flasgger
  • 默认 /apidocs/ 和 路由只在 <code>DEBUG=True 且未显式禁用时才启用;生产环境需手动设 config["SWAGGER"]["validate"] = True 并确认 config["SWAGGER"]["uiversion"] 兼容

文档没渲染出参数或响应体?@swag_from 和 @swag.code 别混用

Flasgger 支持两种注释方式:装饰器式(@swag_from)和内联式(@swag.code + docstring)。两者底层处理逻辑不同,混用容易导致元数据丢失或覆盖。

推荐统一用 @swag_from 配合 YAML 文件,更可控也更易复用:

立即学习“Python免费学习笔记(深入)”;

macOS UI 自动化技能包 —— 用 Python 控制你的 Mac
macOS UI 自动化技能包 —— 用 Python 控制你的 Mac

让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac,无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启:辅助功能 + 屏幕录制权限

下载
  • @swag_from("user_get.yml"):YAML 文件里写清楚 parameters、responses、tags,路径用相对路径(从 app.root_path 开始算)
  • 避免在同一个视图函数上同时写 @swag.code(200) 和 @swag_from(...),后者会覆盖前者
  • YAML 中 in: query 对应 URL 查询参数,in: path 对应路由里的 <id></id>,别写反;类型要用 OpenAPI v2 规范(如 string、integer,不是 Python 的 str 或 int)

POST 接口测试时报 415 Unsupported Media Type?检查 consumes 和请求头

Swagger UI 默认发 Content-Type: application/json,但如果接口实际接收的是 multipart/form-data 或 application/x-www-form-urlencoded,而 YAML 里没声明 consumes,就会触发 415 错误。

必须显式声明接口支持的内容类型:

  • 在 YAML 的 consumes 字段列出所有合法类型,例如:consumes: ["application/json", "application/x-www-form-urlencoded"]
  • 对应地,在 parameters 中按类型组织字段:JSON 用 in: body,表单用 in: formData(注意:Flasgger 基于 Swagger 2.0,不支持 OpenAPI 3.0 的 requestBody 写法)
  • 如果用 in: formData,后端必须用 request.form.get(...) 取值,不能依赖 request.get_json()

本地能跑,部署到 Gunicorn/Nginx 后 /apidocs/ 白屏?静态资源路径被截断

Flasgger 的 UI 依赖 swagger-ui-dist 提供的前端资源,默认走 Flask 的静态路由。但在反向代理环境下(如 Nginx),URL 前缀可能被改写,导致 /apidocs/swagger-ui-bundle.js 404。

关键不是改 Nginx 配置,而是让 Flasgger 知道真实访问路径:

  • 启动时传入 config={"url_prefix": "/api"}(如果 API 文档挂载在 /api/apidocs 下)
  • 或设置 config["SWAGGER"]["specs_route"] = "/api/apidocs/",并确保 Nginx 的 location /api/ 正确透传给 Flask
  • 检查浏览器开发者工具 Network 标签页,确认 swagger.json 是否返回 200 且内容是合法 JSON;如果是 HTML(比如 Nginx 默认 404 页面),说明路由根本没走到 Flask

Flasgger 的自动化程度有限,它不帮你处理反向代理的路径重写逻辑,这部分得靠你对部署拓扑的理解来补全。

热门AI工具

更多
立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

DeepSeek

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

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

豆包大模型

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

WorkBuddy

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

相关专题

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

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

1831

2023.07.20

python能做什么
python能做什么

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

4924

2023.07.25

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

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

1789

2023.07.31

python教程
python教程

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

29477

2023.08.03

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

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

3507

2023.08.04

python eval
python eval

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

3527

2023.08.04

scratch和python区别
scratch和python区别

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

1223

2023.08.11

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

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

616

2023.08.10

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

60

2026.10.28

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

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