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

Python应用Flask如何集成Swagger自动生成接口文档_使用Flasgger插件自动扫描注释

星涛姑娘_1296

星涛姑娘_1296

发布时间:2026-04-11 12:11:27

|

675人浏览过

|

来源于php中文网

原创

能,但需显式启用;初始化时传入parse_docstring=True,且docstring须严格遵循Google或reStructuredText格式,字段名需匹配OpenAPI规范,否则解析失败导致文档空白。

python应用flask如何集成swagger自动生成接口文档_使用flasgger插件自动扫描注释

Flasgger 能不能直接读取函数 docstring 生成 Swagger 文档?

能,但默认不启用。Flasgger 默认只识别 @swag_from 装饰器或 YAML 文件,docstring 需显式开启解析支持。

关键在初始化时传入 parse_docstring=True:

from flasgger import Swagger
swagger = Swagger(app, parse_docstring=True)
  • 不加这个参数,哪怕写得再规范的 docstring(如 Google 风格或 reStructuredText)也不会被扫描
  • 开启后,Flasgger 会尝试用 pydoc 解析,仅支持标准格式,不兼容自定义注释块
  • 如果 docstring 里混用了中文标点、缩进错乱或空行缺失,解析会静默失败——页面上对应接口的文档就变成空字段

如何写 Flasgger 可识别的 docstring?

必须严格遵循 Google 或 reStructuredText 格式,且字段名要和 Swagger OpenAPI 规范对齐。推荐 Google 风格,更直观:

"""
User login endpoint
<hr /><p>tags:</p><div class="aritcle_card flexRow">
                                                        <div class="artcardd flexRow">
                                                                <a class="aritcle_card_img" href="/xiazai/skill6473" title="Sakura python draw"><img
                                                                                src="https://img.php.cn/upload/skill/000/000/081/179098925061873.jpg" alt="Sakura python draw"  onerror="this.onerror='';this.src='/static/lhimages/moren/morentu.png'" ></a>
                                                                <div class="aritcle_card_info flexColumn">
                                                                        <a href="/xiazai/skill6473" title="Sakura python draw">Sakura python draw</a>
                                                                        <p>使用Python的turtle和random库,递归绘制分形樱花树,并动画模拟花瓣自然飘落效果。</p>
                                                                </div>
                                                                <a href="/xiazai/skill6473" title="Sakura python draw" class="aritcle_card_btn flexRow flexcenter"><b></b><span>下载</span> </a>
                                                        </div>
                                                </div><p><span>立即学习</span>“<a href="https://pan.quark.cn/s/00968c3c2c15" style="text-decoration: underline !important; color: blue; font-weight: bolder;" rel="nofollow" target="_blank">Python免费学习笔记(深入)</a>”;</p><ul><li>auth
parameters:</li><li>name: username
in: formData
type: string
required: true</li><li>name: password
in: formData
type: string
required: true
responses:
200:
description: Login success
schema:
type: object
properties:
token:
type: string
"""
  • --- 是分隔符,上面是普通描述,下面是 YAML 定义;缺它整个块会被忽略
  • in: formData 对应 Flask 的 request.form,别写成 body 或 query——否则 UI 上参数不显示
  • 返回值 schema 必须是合法 JSON Schema 片段,type: string 可以,type: str 会报错
  • 不要在 docstring 里写 Python 类型提示(如 :str),Flasgger 不解析它

为什么访问 /apidocs/ 页面空白或报 404?

两个最常见原因:静态资源路径没配对,或 Blueprint 注册顺序不对。

  • Flasgger 自动注册 /apidocs/ 和 /flasgger_static/,但如果 Flask 应用启用了 static_url_path='' 或自定义了 static_folder,会导致 JS/CSS 加载 404
  • 若用 Blueprint 拆分路由,必须在调用 Swagger(app) 之后 再注册 Blueprint;否则 Flasgger 扫不到里面的视图函数
  • 调试时打开浏览器开发者工具,看 Network 标签下是否加载了 /flasgger_static/swagger-ui-bundle.js——没加载就是路径问题
  • 生产环境 Nginx 反向代理时,需显式透传 /flasgger_static/ 路径,不能只代理 /apidocs/

Flasgger 和 Flask-RESTX 能否共存?

技术上可以,但不建议混用。两者都劫持路由注册和文档生成逻辑,容易冲突。

  • Flasgger 基于装饰器和 docstring,Flask-RESTX 基于类视图和 api.model(),混用会导致同一接口出现两套文档入口
  • 如果已有 Flask-RESTX 项目想补 Flasgger,优先改用它的 api.doc() 装饰器,而不是硬塞 docstring
  • Flasgger 的 @swag_from 可加载外部 YAML,适合把 RESTX 的模型定义导出后再复用,但维护成本翻倍
  • 真正需要多格式输出时,直接用 OpenAPI 3.0 标准 YAML + Swagger UI 独立部署更可控

Flasgger 的核心价值是轻量接入,一旦开始绕着它做适配,往往说明该换更结构化的 API 工具链了——尤其是字段校验、版本管理、mock 这些事,它都不管。

热门AI工具

更多
WorkBuddy

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

二狗PPT
二狗PPT Hot

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

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

DeepSeek

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

Atoms
Atoms Hot

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

立刻MV
立刻MV Hot

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

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

豆包大模型

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

咔片AIPPT

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

相关专题

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

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

1671

2023.07.20

python能做什么
python能做什么

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

4204

2023.07.25

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

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

1669

2023.07.31

python教程
python教程

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

24457

2023.08.03

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

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

2987

2023.08.04

python eval
python eval

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

3007

2023.08.04

scratch和python区别
scratch和python区别

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

1163

2023.08.11

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

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

596

2023.08.10

FrankenPHP集成Laravel详细教程
FrankenPHP集成Laravel详细教程

本专题提供FrankenPHP集成Laravel的详细配置指南,全面解析运行原理、开发环境搭建、Caddyfile配置、Octane工作模式、数据库连接、队列任务、定时任务和生产环境优化,解决部署过程中常见的报错与兼容性问题。

40

2026.10.08

热门下载

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

精品课程

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

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