一个Flask-RESTful的方法

原文链接：https://zhuanlan.zhihu.com/p/24719577

 

Flask-RESTful 用来快速实现接口服务是比较方便的。但是实际中RESTful的一套风格不能完全满足我们的需求，所以请求大多都会带上参数。参数的解析和验证成了一个问题。

并不喜欢把解析和验证写在逻辑里。

Flask-RESTful 提供了 reqparse 来做这件事情。

文档给的例子是这样的。

parser = reqparse.RequestParser()
parser.add_argument('task', type=str)


class Todo(Resource):
    def put(self, todo_id):
        args = parser.parse_args()
        task = {'task': args['task']}
        TODOS[todo_id] = task
        return task, 201

但是觉得还可以更进一步。我的是这样的。

from flask_restful_ext import validate, Field


class Todo(Resource):
    @validate(
        Field('task', type=unicode, required=True)
    )
    def put(self, todo_id, task):
        task = {'task': task}
        TODOS[todo_id] = task
        return task, 201

这样代码更简单。

flask_restful_ext 是我自己写的一个模块，来完成这件事情的。

代码如下

# __init__.py
from flask_restful_ext.field import Field
from flask_restful_ext.tools import parser_maker
from functools import wraps


def validate(*args):
    def decorate(func):
        fields = args
        @wraps(func)
        def wrapper(*args, **kwargs):
            p = parser_maker()
            for field in fields:
                p.add_argument(field.name, type=field.type, required=field.required, default=field.default)
            kwargs.update(p.parse_args())
            f = lambda *args, **kwargs: func(*args, **kwargs)
            return f(*args, **kwargs)
        return wrapper
    return decorate

# field.py
class Field(object):
    def __init__(self, name, type=unicode, required=True, default=None):
        self.name = name
        self.required = required
        self.default = default
        self.type = type

# tools.py
from flask_restful import reqparse


def parser_maker():
    return reqparse.RequestParser()

最后附上完整例子。（大部分是文档上的

from flask import Flask
from flask.ext.restful import reqparse, abort, Api, Resource
from flask_restful_ext import validate, Field

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

TODOS = {
    'todo1': {'task': 'build an API'},
    'todo2': {'task': '?????'},
    'todo3': {'task': 'profit!'},
}


def abort_if_todo_doesnt_exist(todo_id):
    if todo_id not in TODOS:
        abort(404, message="Todo {} doesn't exist".format(todo_id))

parser = reqparse.RequestParser()
parser.add_argument('task', type=str)


# Todo
#   show a single todo item and lets you delete them
class Todo(Resource):
    def get(self, todo_id):
        abort_if_todo_doesnt_exist(todo_id)
        return TODOS[todo_id]

    # 文档例子
    # def put(self, todo_id):
    #     args = parser.parse_args()
    #     task = {'task': args['task']}
    #     TODOS[todo_id] = task
    #     return task, 201

    @validate(
        Field('task', type=unicode, required=True)
    )
    def put(self, todo_id, task):
        task = {'task': task}
        TODOS[todo_id] = task
        return task, 201


# TodoList
#   shows a list of all todos, and lets you POST to add new tasks
class TodoList(Resource):
    @validate(Field('name'))
    def get(self, name):
        print name
        return TODOS

##
## Actually setup the Api resource routing here
##
api.add_resource(TodoList, '/todos')
api.add_resource(Todo, '/todos/')


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

最后讲一下。

实现很简单，功能也很简单。代码的命名，变量名，函数名，类名，还需要不断斟酌，欢迎吐槽 ）