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

Python Flask如何实现自动文档生成_集成Swagger实现API在线测试

老涛小哥_2088

老涛小哥_2088

发布时间:2026-03-21 10:24:33

|

633人浏览过

|

来源于php中文网

原创

最省事方式是用flask-swagger-ui:先暴露/openapi.json路由返回合规OpenAPI JSON(含paths、components.schemas、info.title等必填字段),再用get_swaggerui_blueprint挂载UI;注意Nginx需代理.json请求、响应头设Content-Type: application/json,且Swagger UI发请求时需匹配后端接收类型。

python flask如何实现自动文档生成_集成swagger实现api在线测试

Flask 项目里怎么加 Swagger UI 页面

直接用 flask-swagger-ui 最省事,它不改你的路由逻辑,也不要求你写 YAML;把生成的 OpenAPI JSON 接口挂上去就行。核心是两步:暴露一个返回 openapi.json 的路由 + 静态挂载 UI。

  • 别装 flask-restx 或 apispec 除非你 already 在用它们——它们自带 Swagger 集成,但强耦合了定义方式,容易让已有 Flask 路由“被迫重构”
  • flask-swagger-ui 的 get_swaggerui_blueprint 必须传 url 参数,指向你的 OpenAPI spec 地址(比如 /static/openapi.json),不是文件路径
  • OpenAPI JSON 不要硬编码生成——用 flask-swagger-gen 或手写脚本从 @app.route 装饰器+docstring 提取,否则字段漏写、类型错位,UI 上点测试就 400

手动构造 OpenAPI JSON 时哪些字段不能少

Swagger UI 能渲染、能发请求,只依赖三个东西:paths、components.schemas、info.title。少任何一个,页面空白或报 Resolver error。

  • paths 里每个方法必须有 summary 和 responses,哪怕只写 {"200": {"description": "OK"}};没有 responses 就无法生成 “Try it out” 按钮
  • 所有 requestBody 中的 schema 必须在 components.schemas 里定义,且引用格式为 {"$ref": "#/components/schemas/UserInput"};写成内联 {"type": "object"} 会导致 UI 不显示参数输入框
  • 路径参数(如 /users/<user_id></user_id>)要在 paths["/users/{user_id}"] 下声明 parameters,且 name 必须和花括号里一致,大小写敏感

为什么本地能跑,部署到 Nginx 后 Swagger UI 找不到 openapi.json

根本不是跨域问题,而是 Nginx 默认不代理以 .json 结尾的静态请求——它直接返回 404,连 Flask 都没进。

testing-python
testing-python

使用pytest编写和评估有效的Python测试。适用于编写测试、审查测试代码、调试测试失败或提高测试覆盖率。

下载
  • 检查 Nginx 配置里有没有 location ~ \.json$ 这类拦截规则,删掉或加上 proxy_pass http://flask_app;
  • 确保 Flask 返回的 openapi.json 响应头含 Content-Type: application/json;用 curl -I http://yoursite/static/openapi.json 看,如果是 text/plain,Swagger UI 会静默失败
  • 不要把 openapi.json 放在 static/ 目录下靠 Flask 自动 serve——它可能被缓存、没设 MIME 类型;统一走一个视图函数返回,显式设 content_type="application/json"

测试时 POST 请求总卡住或返回 415 Unsupported Media Type

Swagger UI 默认发 Content-Type: application/json,但你的 Flask 路由如果没声明 request.is_json 或没调 request.get_json(),就收不到 body;更常见的是,你写了 @app.route(..., methods=["POST"]) 却没处理 multipart/form-data 或 application/x-www-form-urlencoded。

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

  • 确认路由函数开头有 if not request.is_json: 分支,或统一用 request.get_json(force=True)(仅调试用,线上慎开 force)
  • 如果接口实际接收表单数据,Swagger UI 的 consumes 字段得写成 ["application/x-www-form-urlencoded"],并在 request.form 里取值;否则 UI 仍发 JSON,后端解析失败
  • Swagger UI 的 “Try it out” 对数组参数支持弱——传 tags=["a","b"] 可能被转成字符串 "[\"a\",\"b\"]";建议在 schema 里用 "type": "array", "items": {"type": "string"} 并勾选 “allowEmptyValue”

OpenAPI spec 里每个字段的语义约束比看起来严格得多,少一个引号、多一个空格、路径参数名对不上,Swagger UI 就不给你发请求——它不报错,只是按钮变灰或者点下去没反应。

热门AI工具

更多
DeepSeek

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

豆包大模型

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

墨刀AI
墨刀AI Hot

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

Atoms
Atoms Hot

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

火山引擎

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

WorkBuddy

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

PixPix
PixPix Hot

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

Loomy
Loomy Hot

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

音述AI
音述AI Hot

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

相关专题

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

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

1691

2023.07.20

python能做什么
python能做什么

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

4264

2023.07.25

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

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

1689

2023.07.31

python教程
python教程

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

24817

2023.08.03

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

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

3027

2023.08.04

python eval
python eval

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

3047

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

Kratos框架HTTP与gRPC服务开发教程
Kratos框架HTTP与gRPC服务开发教程

本专题围绕Kratos框架双协议服务开发,涵盖HTTP路由与处理器编写、参数获取、gRPC服务实现与客户端调用、metadata上下文传递、encoding编解码注册、统一响应封装、超时控制与流式响应实现方法。

0

2026.10.10

热门下载

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

精品课程

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

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