我写了一个Flask-restful的快速模板
前言
前几天在进行项目开发的时候，发现用Flask写一些轻量化的Web程序还是比较合适的。其实在Flask家族中，为了能够更加方便的开发Restful风格的接口，Flask-restful是一个不错的选择。虽然Flask-restful提供了比较完整的官方文档，但是距离开发上线项目还是不是很方便，因此我写了一个Flask-restful的快速模板。
此项目采用Mysql作为持久层数据库，实现了一个资源的5个接口，满足基本的web开发需求。
项目地址
首先给出项目地址：Flask-restful-quick-start
项目简介
首先是项目的文件结构。
├── flask_app
│ ├── common
│ │ ├── __init__.py
│ │ └── utils.py
│ ├── user
│ │ ├── __init__.py
│ │ ├── models.py
│ │ └── views.py
│ └── __init__.py
├── config.py
├── LICENSE
├── main.py
└── requirements.txt
项目中采用了蓝图来划分功能块，方面划分项目模块，并且提升可维护性。
目前我认为这是一个相对比较科学的文件组织方案了。
Restful接口设计
基本的接口从两个路由进行接收
======================================
请求方法 路由 请求内容
POST /userList userInfo
GET /userList None
GET /user userId
PUT /user userInfo
DELETE /user userId
======================================
做一个简单的介绍就是增加资源和查询全部资源从资源列表接口走。
其他的带参数请求和修改、删除等从专门的资源接口走。
这样就能避免GET请求带参数和不带参数的问题了。
在项目中统一的处理能够提升可靠性，降低编码错误，我这里对两点进行了统一。
1、Sqlalchemy的Model层对象和dict之间的转换。
def row2dict(row):
"""
参考文档 https://stackoverflow.com/questions/1958219/convert-sqlalchemy-row-object-to-python-dict
将model转换为dict
:param row: Sqlalchemy model
:return: 输出的字典
"""
out_dict = {}
for column in row.__table__.columns:
out_dict[column.name] = str(getattr(row, column.name))
return out_dict
通过以上代码即可轻松地将model转换为dict的字典了。
2、统一的回复内容
class BaseResponse:
def __init__(self):
self.result_code_success = 200
self.result_code_fail = 201
def success(self, msg="success", data={}):
result = {
"code": self.result_code_success,
"message": msg,
"data": data
}
return jsonify(result)
def fail(self, msg="fail", data={}):
result = {
"code": self.result_code_fail,
"message": msg,
"data": data
}
return jsonify(result)
统一的回复内容包括了“成功”和“失败”两种情况，可自定义回复编码和内容。
启动项目
安装
首先克隆本项目
$ git clone git@github.com:Jarrettluo/flask-restful-quick-start.git
cd flask-restful-quick-start
建议大家使用ide创建一个虚拟环境venv，避免项目使用的包与系统包不一致。
$ pip install requirements.txt
最后启动项目，开始开发
$ python run main.py
修改配置
在项目中的init.py中设置了连接数据库的各项参数，这些都是需要来自定义设置的。
user = "root"
password = "123456"
database = "flask_quick" # 需要修改的内容
app.config["SQLALCHEMY_DATABASE_URI"] = "mysql://%s:%s@localhost:3306/%s" % (user, password, database)
在这里使用了MysqlDB，可以根据实际情况，进行修改。
同时也强烈建议大家将这些设置信息放到config.py文件中，这样方便统一修改。
在主程序中，防止了一个数据库初始化的方法，可以进行数据库的清空和创建。
def init_db():
# 丢掉全部表
db.drop_all()
# 创建全部表
db.create_all()
快速开发
增加模块就只需要将现有的user模块复制以后进行修改即可。
在flask_app.__init.py中注册蓝图
from flask_app.user import user_blueprint
app.register_blueprint(user_blueprint, url_prefix="/user")
在flask_app.user.__init.py中增加蓝图
user_blueprint = Blueprint("user_blueprint", __name__, url_prefix="/user")
from flask_app.user import views
enjoy。
结尾
纯新手向的指导，更多的内容请参考Flask_restful的官方文档.
如果您觉得上面的内容对您有帮助欢迎点赞、评论、转发！
更多内容请查阅作者博客：https://jiaruiblog.com
或者star作者github: https://github.com/Jarrettluo?tab=repositories
