Flask API 项目 Swagger 版本打架不兼容
Flask API 项目 Swagger 版本打架不兼容1. 问题配景
在利用 Flask 3.0.0 时遇到以下问题：
[*]安装 flask_restful_swagger 时，它逼迫将 Flask 降级到 1.1.4，并导致其他依赖（如 flask-sqlalchemy、flask-apispec）出现版本冲突。
[*]必要办理 Flask 版本兼容问题，并且集成 Swagger API 文档。
2. 问题分析
[*]flask_restful_swagger 是一个较为过时的库，已经不再更新，且与 Flask 3.x 版本不兼容。
[*]flask-sqlalchemy 和 flask-apispec 必要 Flask >= 2.2.5 版本，而 flask_restful_swagger 安装时逼迫降级 Flask 版本会导致兼容性问题。
3. 办理方案
为相识决版本冲突，采用以下方案：
[*] 安装 flask_restful_swagger 时会降级 Flask 版本：
[*]在项目中，利用 flask_restful_swagger 的版本 0.20，它将 Flask 版本降级到 1.1.4。
[*] 手动办理版本冲突：
[*]安装完成后，立即 卸载 Flask 1.1.4 并安装 Flask 3.0.0，否则 flask-sqlalchemy、flask-apispec 等插件会报错。
具体步骤如下：
步骤一：安装兼容包
[*] 安装 flask_restful_swagger 最新版本（0.20）：
pip install flask_restful_swagger
步骤二：安装Flask
[*] 卸载 Flask 1.1.4：
pip uninstall flask
[*] 安装 Flask 3.0.0：
pip install flask==3.0.0
步骤三：设置 Flask 和 Flask-APISpec
[*] 应用设置 (__init__.py)：
在程序文件 __init__.pyy 中进行以下设置：
from flask import Flask
from flask_apispec import FlaskApiSpec
from flask_restful import Api, Resource
from flask_sqlalchemy import SQLAlchemy
from flask_restful_swagger import swagger
from apispec import APISpec
from apispec.ext.marshmallow import MarshmallowPlugin
# 实例化 Flask 应用
app = Flask(__name__)
# 配置 OpenAPI 和 Swagger 文档
app.config.update({
'APISPEC_SPEC': APISpec(
title='My API',
version='v1',
plugins=,
openapi_version='2.0.0'
),
'APISPEC_SWAGGER_URL': '/swagger/',# Swagger JSON
'APISPEC_SWAGGER_UI_URL': '/swagger-ui/'# Swagger UI
})
# 实例化 Flask-RESTful API
api = Api(app)
db = SQLAlchemy(app)
# 配置 FlaskApiSpec 用于注册 Swagger 文档
docs = FlaskApiSpec(app)
步骤四：定义资源和路由
通过利用 Flask-RESTful 和 flask-apispec 来定义 API 资源，并添加 Swagger 文档注解。
[*] API 资源类：
class UserResource(Resource):
@doc(description="获取用户详情"，tags=)# 文档注解
def get(self):
return {"message": "Hello, World!"}
[*] 将资源添加到 API：
api.add_resource(BookResource, '/books/<int:book_id>')
docs.register(BookResource)# 注册到 API 文档
上面代码中，@doc 注解为该接口天生文档说明，docs.register() 将资源添加到 Swagger 文档中。
步骤五：访问 Swagger 文档
[*]启动 Flask 应用后，访问 http://127.0.0.1:5000/swagger-ui/ 来查看主动天生的 Swagger UI。
[*]http://127.0.0.1:5000/swagger/ 返回的是 Swagger JSON 文档。
https://i-blog.csdnimg.cn/img_convert/4fbdcf5e76157fb8d896a9828a737f7f.png
4. 总结
[*]通过手动卸载并重新安装 Flask 3.0.0，结合 flask-apispec，可以办理 flask_restful_swagger 与 Flask 3.0.0 的版本冲突问题，并实现现代的 API 文档生乐成能。
[*]完整流程：
[*]安装 flask_restful_swagger，它会将 Flask 降级到 1.1.4。
[*]卸载 Flask 1.1.4 并重新安装 Flask 3.0.0。
[*]设置 Flask 和 Flask-APISpec 以天生 Swagger 文档。
wagger`**，它会将 Flask 降级到 1.1.4。
[*]卸载 Flask 1.1.4 并重新安装 Flask 3.0.0。
[*]设置 Flask 和 Flask-APISpec 以天生 Swagger 文档。
[*]定义 API 资源和路由，并通过 Swagger 天生 API 文档。
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。
页:
[1]