使用Flask快速构建REST应用

引言

最近在某个小型项目上进行了一些尝试，目标是用极快的速度构建一套简洁且优雅的小型WEB系统。当然这次尝试可以说是失败的，稍后会提到。

架构上主要是前后端分离，后端使用Python实现RESTFul API，前端直接套用AdminLTE模版。

得益于Python动态语言的特性，后端可以做到非常少量的代码实现增删改查等基本功能，大约是可以使用100多行代码写了25个REST服务吧，非常惊人。虽然比较简陋，但比起之前使用Spring Boot全家桶来开发REST，要快得太多。

但比起后端，前端的代码量，初版写出来之后，是后端的几十倍，使用gulp构建，include等插件后，做到了一定简化，接下来还要做SPA化，引入vue.js、webpack等等，最终会变成 为了目的不择手段，为了手段而忘记目的 。一个很重要的前提是，要做一个 小型WEB系统 ，整体成本要小。所以前后端分离虽然好处多多，但前端太重了，并不适合小型系统。

最终还是使用了Flask+Jinja，传统的重后端、轻前端的方式来实现，将总体代码量控制到了极少。
但这次的REST API部分，不失为一次有益的尝试，单独拿出来做成脚手架，提供给有需要的人吧。

源码

http://git.si-tech.com.cn/guolei/flask-rest-sample
https://github.com/xiiiblue/flask-rest-sample

简介

flask-rest-sample 是一个使用Python编写的REST API，可以对多个资源提供增删改查服务，用于快速构建REST应用。

Web框架使用Flask
ORM框架使用peewee
安全方面使用了flask-jwt插件进行JWT(Json Web Token)认证
由于flask-rest/flask-restplus侵略性较强，本次没有使用。
可以考虑自行使用flasgger添加SwaggerUI文档。

第三方依赖

peewee
pymysql
Flask
Flask-JWT
flask-script

主要代码示例

建模时尽量避免使用外键等约束条件，保证模型结构上一致，可以做到共用一个公共服务。

可使用@rest.route添加多个资源

# 基本API
@rest.route('/api/reports', methods=['GET', 'POST'])
@rest.route('/api/reports/<id>', methods=['GET', 'PUT', 'DELETE'])
@rest.route('/api/res2', methods=['GET', 'POST'])
@rest.route('/api/res2/<id>', methods=['GET', 'PUT', 'DELETE'])  #只要模型结构一致，可以添加多个资源
@jwt_required()
def common_rest_api(id=None):
    model_name = request.path.split('/')[2]  
    pee_wee_model = utils.get_model_by_name(model_name)  #从URL中确定模型
    if not pee_wee_model:
        return utils.jsonresp(status=400, errinfo='model_name不正确')

    if id:
        # 查询
        if request.method == 'GET':
            try:
                model = pee_wee_model.get(pee_wee_model.id == id)
            except:
                return utils.jsonresp(status=404, errinfo='查询不到资料')
            return utils.jsonresp(jsonobj=utils.obj_to_dict(model))
        # 修改
        elif request.method == 'PUT':
            json_dict = request.get_json(silent=True, force=True)
            if not json_dict: return utils.jsonresp(status=400, errinfo='参数格式不正确')
            try:
                model = pee_wee_model.get(pee_wee_model.id == id)
            except:
                return utils.jsonresp(status=404, errinfo='查询不到资料')
            utils.dict_to_obj(dict=json_dict, obj=model, exclude=('id',))  # 去掉ID字段
            model.save()
            return utils.jsonresp(status=201)
        # 删除
        elif request.method == 'DELETE':
            try:
                pee_wee_model.get(pee_wee_model.id == id).delete_instance()
            except:
                return utils.jsonresp(status=404, errinfo='查询不到资料')
            return utils.jsonresp(status=204)
        else:
            return utils.jsonresp(status=405, errinfo='不支持的HTTP方法')
    else:
        # 全量查询（支持分页、排序、搜索）
        if request.method == 'GET':
            # 处理查询参数
            logger.debug(request.args)
            try:
                # 当前页码
                page = request.args.get('page', '')
                if page: page = int(page) + 1
                # 每页展示数量
                length = request.args.get('length', '')
                if length:
                    length = int(length)
                else:
                    length = cfg.ITEMS_PER_PAGE
                # 排序
                sort = request.args.get('sort', '')
                if sort:
                    sort_column = sort.split(',')[0]
                    sort_direction = sort.split(',')[1]
            except:
                return utils.jsonresp(status=400, errinfo='参数格式不正确')

            # 查询
            query = pee_wee_model.select()
            total_count = query.count()

            # 排序
            if sort:
                if sort_column in pee_wee_model._meta.fields:
                    field = getattr(pee_wee_model, sort_column)
                    if sort_direction != 'asc':
                        field = field.desc()
                    query = query.order_by(field)
            # 分页
            if page:
                query = query.paginate(page, length)

            dict = {'content': utils.query_to_list(query), 'totalElements': total_count}
            return utils.jsonresp(jsonobj=dict)
        # 新增
        elif request.method == 'POST':
            json_dict = request.get_json(silent=True, force=True)
            if not json_dict: return utils.jsonresp(status=400, errinfo='参数格式不正确')
            user = utils.dict_to_obj(dict=json_dict, obj=pee_wee_model(), exclude=['id'])  # 去掉ID字段
            user.save()
            return utils.jsonresp(status=201)
        else:
            return utils.jsonresp(status=405, errinfo='不支持的HTTP方法')

环境配置

venv虚拟环境安装配置

1
2
3

sudo pip3 install virtualenv
virtualenv venv
. venv/bin/activate

第三方依赖安装

1 2	pip3 install -r requirements.txt

系统参数配置

编辑config.py，修改SECRET_KEY及MySQL数据库相关参数

SECRET_KEY = os.environ.get('SECRET_KEY') or 'your-secret'
DB_HOST = '127.0.0.1'
DB_USER = 'foobar'
DB_PASSWD = 'foobar'
DB_DATABASE = 'foobar'

编辑log-app.conf，修改日志路径
1
args=('/path/to/log/flask-rest-sample.log','a','utf8')
数据库初始化
自动建表
直接运行python3 models.py

插入管理员用户（默认admin/admin)

1
2
3

INSERT INTO `user` (`id`, `username`, `password`, `fullname`, `email`, `phone`, `status`)
VALUES
	(1, 'admin', 'pbkdf2:sha1:1000$Km1vdx3W$9aa07d3b79ab88aae53e45d26d0d4d4e097a6cd3', '管理员', 'admin@admin.com', '18612341234', 1);

启动应用

1
2
3

nohup ./manage.py runserver 2>&1 &
或
./run_app_dev.py (仅限测试)

REST接口说明

以reports资源为例：

GET /api/reports/ 查询
200 成功

PUT /api/reports/ 修改
201 成功
DELETE /api/reports/ 删除
204 成功
POST /api/reports 新增
200 成功
GET /api/reports 全量查询
200 成功

支持分页（URL参数：page、length）及排序(URL参数：sort)
参数示例：?page=1&length=5&sort=serial_number,desc

JWT认证简单说明

向/api/auth发起用户认证请求

POST http://127.0.0.1:5000/api/auth
Content-Type: application/json
{
    "username": "admin",
    "password": "admin"
}

获取响应，取得access_token

1
2
3

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0OTE2MzUyNTQsIm5iZiI6MTQ5MTYzNTI1NCwiaWRlbnRpdHkiOjEsImV4cCI6MTQ5MTYzNTU1NH0.wq-uer9LbRP5hEYGT4WfD5O4jf7k7du2Q1K6musKzvU"
}

在接下来的HTTP请求头中，加入Authorization，值为JWT+空格+access_token
以获取当前用户信息为例
请求：

1
2

GET http://127.0.0.1:5000/api/identity
Authorization: JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE0OTE2MzUyNTQsIm5iZiI6MTQ5MTYzNTI1NCwiaWRlbnRpdHkiOjEsImV4cCI6MTQ5MTYzNTU1NH0.wq-uer9LbRP5hEYGT4WfD5O4jf7k7du2Q1K6musKzvU

响应：

{
  "email": "admin@admin.com",
  "fullname": "管理员",
  "username": "admin",
  "phone": "18612341234"
}

引言

源码

简介