Flask 学习-41.Flask-RESTPlus 入门到放弃

Posted 2022-09-05 上海-悠悠

前言

Flask-restfull 是flask 框架开发接口的一个框架，Flask-RESTPlus是Flask-restfull 升级版，功能做了一些优化，主要是可以生成swagger 在线文档了。

环境准备

先安装 Flask-RESTPlus 插件

pip install flask-restplus

目前最新版本v0.13.0 官方文档地址https://flask-restplus.readthedocs.io/en/stable/quickstart.html

快速入门

与其他所有扩展一样，可以使用应用程序对象对其进行初始化：

from flask import Flask
from flask_restplus import Api

app = Flask(__name__)
api = Api(app)

或者懒惰地使用工厂模式：

from flask import Flask
from flask_restplus import Api

api = Api()

app = Flask(__name__)
api.init_app(app)

hello world 程序

一个最小的 Flask-RESTPlus API 如下所示：

from flask import Flask
from flask_restplus import Resource, Api

app = Flask(__name__)
api = Api(app)

@api.route('/hello')
class HelloWorld(Resource):
    def get(self):
        return 'hello': 'world'

if __name__ == '__main__':
    app.run(debug=True)

但是启动就会报错

Traceback (most recent call last):
  File "D:/demo/xuexi_flask/app.py", line 3, in <module>
    from flask_restplus import Resource, Api
  File "D:\\demo\\xuexi_flask\\venv\\lib\\site-packages\\flask_restplus\\__init__.py", line 4, in <module>
    from . import fields, reqparse, apidoc, inputs, cors
  File "D:\\demo\\xuexi_flask\\venv\\lib\\site-packages\\flask_restplus\\fields.py", line 17, in <module>
    from werkzeug import cached_property
ImportError: cannot import name 'cached_property' from 'werkzeug' (D:\\demo\\xuexi_flask\\venv\\lib\\site-packages\\werkzeug\\__init__.py)

主要原因是 werkzeug 这个模块不兼容，由于 Flask-RESTPlus 的作者很久没更新了，小伙伴们都找不到这个作者了，这个项目也被放弃了.
在github上可以看到https://github.com/noirbizarre/flask-restplus

为了让这个项目继续更新下去，现在用Flask-RESTX 代替了。
Flask-RESTX 官网地址https://flask-restx.readthedocs.io/en/latest/quickstart.html
Flask-RESTX github 地址https://github.com/python-restx/flask-restx

网上看到关于Flask-RESTPlus 的教程是比较老的版本了，最新的flask 2.2.2版本并不支持，所以这个还没入门的小伙伴可以直接放弃，去学Flask-RESTX。