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

怎样在Python Flask中使用Swagger-UI自动生成API交互文档?

浅瑶酱_8665

浅瑶酱_8665

发布时间:2026-07-28 07:56:19

|

642人浏览过

|

来源于php中文网

原创

直接用 flask-swagger-ui 最省事,它不改路由逻辑、无需 YAML/JSON 文件,自动列出 @app.route 或 @blueprint.route 接口;需手动提供 /swagger.json(如用 apispec + marshmallow 生成),并确保 URL 完整、JSON 合法、参数显式声明。

怎样在python flask中使用swagger-ui自动生成api交互文档?

Flask 项目里怎么接入 Swagger-UI?

直接用 flask-swagger-ui 最省事,它不改你的路由逻辑,也不要求你写 YAML/JSON 文件——只要你的 Flask 接口返回标准 JSON,它就能把 @app.route 或 @blueprint.route 自动列出来。别碰 flasgger,它强制加 docstring 解析,一不小心就报 yaml.scanner.ScannerError,而且对嵌套结构支持差。

实操步骤很简单:

  • 装包:pip install flask-swagger-ui
  • 在 Flask app 初始化后加几行代码,把 Swagger UI 挂到 /docs 路径
  • 确保所有 API 都有明确的 methods 和返回值(哪怕只是 {"msg": "ok"}),否则 Swagger 会漏掉接口

为什么 /swagger.json 一直 404?

因为 flask-swagger-ui 默认不生成 /swagger.json,它只提供 UI 界面,不自动提取接口定义。你得自己提供这个 JSON 文件——要么手写,要么用工具生成。最常用的是 apispec + marshmallow 组合:

  • 给每个视图函数加 @doc 装饰器(来自 apispec)或写 spec.path() 手动注册
  • 用 spec.to_dict() 输出 JSON,并通过一个新路由暴露为 /swagger.json
  • 注意:Flask 的 url_for 在 CLI 启动时可能拿不到上下文,spec.to_dict() 要放在 app.after_request 或独立路由里执行

示例路由:

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

提示词大师-python版
提示词大师-python版

图片提示词生成器?不止如此。 马甲系统 —— 把脑海中的画面,翻译成AI能理解的专业表达。 用得越多,它越懂你:首次需要多问几句确认方向,用久了几乎一说就懂。 用得越多,它越快:缓存机制让后续对话越来越省。 RAG进化:成功案例持续入库,越跑越聪明。 输入「新手指南」查看完整功能介绍

下载
@app.route('/swagger.json')
def swagger_json():
    return jsonify(spec.to_dict())

Swagger UI 页面打开但没显示接口?

大概率是 UI 加载的 swagger.json 地址不对,或者 JSON 格式不合法。打开浏览器开发者工具 → Network 标签,看 swagger.json 请求是否返回 200 且 Content-Type 是 application/json。

  • 检查 swagger_ui.init_app(app) 里传的 config 中 url 字段,比如设成 "http://localhost:5000/swagger.json" —— 必须是完整 URL,不能写相对路径 /swagger.json
  • 用 json.loads() 手动校验 swagger.json 内容,常见错误包括:缺失 paths 字段、responses 下没写 200、schema 里用了 Python 类型名(如 <class 'str'>)而不是 OpenAPI 类型(如 "string")
  • 如果用了 Blueprint,记得在注册 Blueprint 前先调用 spec.register_blueprint(bp),否则路径不会进 spec

如何让 POST 接口在 Swagger 里支持表单提交?

默认 Swagger 把所有 POST 当 JSON 提交,但很多 Flask 接口实际用 request.form 或 request.files。要让它显示 “Try it out” 下拉菜单并允许填 form-data,必须在 spec.path() 或 @doc 中显式声明 consumes 和参数类型:

  • 对于普通表单字段,用 {"in": "formData", "name": "username", "type": "string"}
  • 对于文件上传,加 "type": "file" 并设 "consumes": ["multipart/form-data"]
  • 别依赖自动推断——flask-swagger-ui 不解析视图函数内部的 request.form 调用,全靠你手动描述

否则 Swagger 会发 JSON body,而你的视图还在等 request.form.get("xxx"),结果就是 400 或空数据。

OpenAPI 的 formData 已被废弃,新项目建议统一走 JSON body + request.get_json(),省去一堆适配麻烦。但老接口改不动时,文档层只能硬补。

热门AI工具

更多
墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

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

PixTV
PixTV Hot

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

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

WorkBuddy

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

DeepSeek

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

豆包大模型

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

火山引擎

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

讯飞绘文

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

相关专题

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

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

1631

2023.07.20

python能做什么
python能做什么

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

3944

2023.07.25

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

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

1629

2023.07.31

python教程
python教程

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

22717

2023.08.03

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

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

2787

2023.08.04

python eval
python eval

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

2827

2023.08.04

scratch和python区别
scratch和python区别

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

1123

2023.08.11

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

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

596

2023.08.10

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

0

2026.09.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Python Web框架Flask进阶视频教程
Python Web框架Flask进阶视频教程

共12课时 | 3.3万人学习

Python Web框架Flask入门视频教程
Python Web框架Flask入门视频教程

共7课时 | 2.8万人学习

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

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