Flask框架之RESTful--参数验证--add_argument方法参数详解
目录
参数验证
参数验证的重要性
Flask-RESTful 参数验证方法
基本用法
1. 使用 reqparse 模块
示例
代码详解
2. 使用 marshmallow 库
示例
代码详解
add_argument方法参数详解
名词解释
代码案例
参数验证
参数验证也叫参数解析
Flask-Restful插件提供了类似WTForms来验证提交的数据是否合法的包，叫做reqparse。
参数验证的重要性
- 增加安全性：通过验证参数可以避免恶意输入或攻击。
- 提供良好的用户体验：验证参数可以确保用户提供的数据符合预期，并给出清晰的错误提示。
- 避免错误处理：验证参数可以帮助开发者在处理参数时减少错误。
Flask-RESTful 参数验证方法
基本用法
通过
flask_restful.reqparse中RequestParser建立解析器通过
RequestParser中的add_argument方法定义字段与解析规则通过
RequestParser中的parse_args来解析参数
- 解析正确，返回正确参数
- 解析错误，返回错误信息给前端
1. 使用 reqparse 模块
Flask-RESTful 提供了 reqparse 模块，用于解析和验证请求参数。您可以通过定义参数的类型、必需性、默认值等来验证参数。
示例
- 导入所需的模块和类。
- 创建一个
RequestParser对象。- 使用
add_argument方法定义每个参数的类型、必需性和其他属性。- 在资源方法中使用
parse_args方法解析和验证参数。
from flask import Flask
from flask_restful import Api, Resource, reqparse
app = Flask(__name__)
api = Api(app)
parser = reqparse.RequestParser()
parser.add_argument('name', type=str, required=True, help='Name is required')
parser.add_argument('age', type=int, default=18, help='Age must be an integer')
class UserResource(Resource):
def post(self):
args = parser.parse_args()
name = args['name']
age = args['age']
# 进行其他操作...
return {'message': 'User created successfully'}, 201
api.add_resource(UserResource, '/users')
if __name__ == '__main__':
app.run()
代码详解
定义两个参数 name 和 age。name 是必需的，而 age 是可选的，默认值为 18。如果请求中未提供 name 参数，或者 age 参数不是整数类型，将返回相应的错误响应。
2. 使用 marshmallow 库
使用 marshmallow 库：marshmallow 是一个强大的序列化和验证库，可以与 Flask-RESTful 结合使用。您可以定义一个模式（Schema）来验证请求参数。
示例
- 导入所需的模块和类。
- 创建一个参数验证的模式（Schema），定义每个参数的类型和验证规则。
- 在资源方法中使用模式的
load方法加载和验证参数。 - 处理验证失败的情况，返回适当的错误响应。
from flask import Flask
from flask_restful import Api, Resource
from marshmallow import Schema, fields, ValidationError
app = Flask(__name__)
api = Api(app)
class UserSchema(Schema):
name = fields.Str(required=True, error_messages={'required': 'Name is required'})
age = fields.Int()
user_schema = UserSchema()
class UserResource(Resource):
def post(self):
try:
data = user_schema.load(request.get_json())
except ValidationError as err:
return {'error': err.messages}, 400
name = data['name']
age = data.get('age', 18)
# 进行其他操作...
return {'message': 'User created successfully'}, 201
api.add_resource(UserResource, '/users')
if __name__ == '__main__':
app.run()
代码详解
使用 marshmallow 定义了一个 UserSchema 来验证请求参数。如果验证失败，将返回包含错误消息的响应。
add_argument方法参数详解
名词解释
add_argument方法可以指定这个字段的名字，这个字段的数据类型等，验证错误提示信息等，具体如下：
-
default：默认值，如果这个参数没有值，那么将使用这个参数指定的默认值。
-
required：是否必须。默认为False，如果设置为True，那么这个参数就必须提交上来。
-
type：这个参数的数据类型，如果指定，那么将使用指定的数据类型来强制转换提交上来的值。可以使用python自带的一些数据类型(如str或者int)，也可以使用flask_restful.inputs下的一些特定的数据类型来强制转换。
- url：会判断这个参数的值是否是一个url，如果不是，那么就会抛出异常。
- regex：正则表达式。
- date：将这个字符串转换为datetime.date数据类型。如果转换不成功，则会抛出一个异常.
-
choices：固定选项。提交上来的值只有满足这个选项中的值才符合验证通过，否则验证不通过。
-
help：错误信息。如果验证失败后，将会使用这个参数指定的值作为错误信息。
-
trim：是否要去掉前后的空格。
-
action：参数的动作。可以是'store'（默认）或'append'。如果设置为'store'，将仅保留最后一个传递的参数值；如果设置为'append'，将保留所有传递的参数值，并将它们存储为列表。 -
location：参数的位置。可以是'json'、'args'、'form'、'headers'、'cookies'或'files'中的一个。用于指定参数在请求中的位置。 -
store_missing：是否存储缺失的参数。如果设置为True，缺失的参数将被存储为None；如果设置为False，缺失的参数将被忽略，默认为True。 -
ignore：是否忽略参数。如果设置为True，请求中的参数将被忽略，不进行验证和存储。
代码案例
from flask import Flask
from flask_restful import Api,Resource,inputs
from flask_restful.reqparse import RequestParser
app = Flask(__name__)
api = Api(app)
class RegisterView(Resource):
def post(self):
# 建立解析器
parser = RequestParser()
# 定义解析规则
parser.add_argument('uname',type=str,required=True,trim=True,help='用户名不符合规范')
parser.add_argument('pwd',type=str,help='密码错误',default='123456')
parser.add_argument('age',type=int,help='年龄验证错误！')
parser.add_argument('gender',type=str,choices=['男', '女','保密'],help='性别验证错误')
parser.add_argument('birthday',type=inputs.date,help='生日验证错误')
parser.add_argument('phone',type=inputs.regex('^1[356789]\d{9}$'),help='电话验证错误')
parser.add_argument('homepage',type=inputs.url,help='个人主页验证错误')
# 解析数据
args = parser.parse_args()
print(args)
return {'msg':'注册成功！'}
api.add_resource(RegisterView,'/register/')
if __name__ == '__main__':
app.run(debug=True)