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

如何利用Python Flask构建符合OpenAPI 3.0规范的接口?

云敏姑娘_7491

云敏姑娘_7491

发布时间:2026-07-16 12:15:55

|

258人浏览过

|

来源于php中文网

原创

flask-openapi3是目前最省心、最贴近Flask原生风格的OpenAPI 3.0方案,它基于Python类型注解和Pydantic模型自动推导API结构,无需装饰器硬编码Schema,避免flasgger(已停更、仅支持OpenAPI 2.0)和flask-apispec(需显式绑定Schema、易报序列化错误)的缺陷;默认文档路径为/apidoc/swagger,需注意勿与/docs等路径混淆,且主干适配Pydantic v2,降级需锁定v1.x版本。

如何利用python flask构建符合openapi 3.0规范的接口?

flask-openapi3 是目前最省心、最贴近 Flask 原生风格的 OpenAPI 3.0 方案,它不依赖装饰器硬编码 Schema,也不强制你写一堆 @use_kwargs,能自动提取路由参数、请求体结构和响应模型,生成合法、可直接用于 Swagger UI 的文档。

为什么选 flask-openapi3 而不是 flasgger 或 flask-apispec?

因为 flasgger 已停止维护,且只支持 OpenAPI 2.0;flask-apispec 要求你为每个接口显式绑定 marshmallow.Schema,稍一漏写或传错实例(比如传 MySchema 而非 MySchema()),就会报 TypeError: Object of type Schema is not JSON serializable。而 flask-openapi3 直接用 Python 类型注解 + Pydantic 模型推导结构,更自然、更少出错。

flask-openapi3 怎么定义一个带 body 和 query 参数的接口?

关键在类型注解和 Body/Query 包装器,框架会自动映射到 OpenAPI 字段:

  • 路径参数(如 /users/{uid})直接用函数参数名匹配,类型注解为 int 或 str 即可
  • 查询参数(?page=1&limit=10)用 Query(...) 包裹,并设默认值或 None
  • JSON 请求体必须用 Body(...) 显式声明,否则会被忽略
  • 响应模型用 responses 字典指定状态码和 Pydantic 模型,例如 {200: UserOut}

示例:

from flask_openapi3 import OpenAPI, Info
from pydantic import BaseModel
from typing import Optional

app = OpenAPI(__name__, info=Info(title="User API", version="1.0"))

class UserIn(BaseModel):
    name: str
    email: str

class UserOut(BaseModel):
    id: int
    name: str

@app.post('/users')
def create_user(body: UserIn = Body(...), 
                page: int = Query(1, description="页码")):
    return {"id": 1, "name": body.name}, 200

如何让文档页面正常访问,而不是 404?

默认路径是 /apidoc/swagger,不是 /swagger 或 /docs —— 这个路径容易被误记,导致白屏。如果想改,必须显式配置 url_prefix:

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

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

下载

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

  • 启动时加 url_prefix="/docs": OpenAPI(app, info=info, url_prefix="/docs")
  • 确保没和其他蓝图冲突,尤其不要在 app.route 里重复定义 /apidoc 路径
  • 如果用了 Nginx 反向代理,注意静态资源路径是否被重写(Swagger UI 依赖 /apidoc/static/ 下的 JS/CSS)

Pydantic v1 和 v2 兼容性问题怎么绕开?

flask-openapi3 当前主干适配的是 Pydantic v2(BaseModel 不再有 Config 类,改用 model_config)。如果你项目还在用 v1,会出现 AttributeError: 'Field' object has no attribute 'default_factory' 等报错:

  • 升级到 Pydantic v2 是首选方案:pip install --upgrade pydantic
  • 若无法升级,锁定 flask-openapi3<2.0(v1.x 版本仍支持 Pydantic v1)
  • 别混用:v2 的 @field_validator 在 v1 下无效,反之亦然

文档生成本身不复杂,但类型系统一旦错位,OpenAPI JSON 就会缺失字段或校验失效——这点比路由逻辑更难 debug,建议在本地跑通后,用 curl http://localhost:5000/apidoc/openapi.json 直接看原始 spec 是否包含你期望的 requestBody 和 parameters。

热门AI工具

更多
Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

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

豆包大模型

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

音述AI
音述AI Hot

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

DeepSeek

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

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

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

WorkBuddy

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

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

相关专题

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

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

1591

2023.07.20

python能做什么
python能做什么

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

3824

2023.07.25

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

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

1609

2023.07.31

python教程
python教程

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

22077

2023.08.03

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

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

2707

2023.08.04

python eval
python eval

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

2767

2023.08.04

scratch和python区别
scratch和python区别

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

1103

2023.08.11

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

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

596

2023.08.10

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

140

2026.09.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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