Flask-RESTful与Flask-WTF表单集成

Question

我在Flask-RESTful中使用Flask。我有一个获取数据的POST方法，我需要对它应用验证检查。我的问题是，我可以像Django-Forms一样使用Flask-WTF来处理验证和检查吗？

对于我需要检查系统中是否已经存在电子邮件的Signup方案，您更喜欢哪种技术？

Answer 1

Flask-RESTful的reqparse模块提供了您想要的东西。通过定义您自己的输入域类型，您可以执行一些验证操作。下面是一个从头开始的示例：

from flask import Flask
from flask.ext.restful import Api, Resource, reqparse

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


def is_email_valid(address):
    # Check if the e-mail address already exists in database.
    return True  # or False

def email(value):
    if not is_email_valid(value):
        raise ValueError("The e-mail address {} is already taken.".format(value))

    return value

class Users(Resource):
    parser = reqparse.RequestParser()
    parser.add_argument('email', type=email, help='Signup email')

    def post(self):
        args = self.parser.parse_args()
        # Create the new user with args.items()
        return "user representation", 201


api.add_resource(Users, '/users')


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

如果参数未能通过验证，解析器会自动响应400 Bad Request。

您可以在Flask-RESTful的documentation中找到更多信息。

类似地，您可以使用WTForms完成此操作：

from flask import Flask, request
from flask.ext.restful import Api, Resource, abort
from wtforms import Form, fields, validators

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


# WTForms
def is_email_valid(address):
    # Check if the e-mail address already exists in database.
    return True  # or False

def user_email(form, field):
    if not is_email_valid(field.data):
        raise validators.ValidationError("The e-mail address {} is already taken.".format(field.data))

class UserForm(Form):
    email = fields.StringField('Email', [validators.Email(), user_email])


# Flask-RESTful
class Users(Resource):
    def post(self):
        form = UserForm(data=request.get_json())
        if form.validate():
            # Create the new user with form.populate_obj()
            pass
        else:
            abort(400)
        return "user representation", 201


api.add_resource(Users, '/users')


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

但是，即使使用WTForms实现，也必须定义表单的字段，除非您使用兼容的ORM。例如，WTForms的some extensions从模型生成表单的方式与Django ORM模型类似。