FlaskRESTful之请求处理(RequestParser)

RequestParser请求处理

使用步骤:

1. 导包

from flask_restful.reqparse import RequestParser

2. 创建requestparser对象

        # 1. 创建RequestParser实例
        parser = RequestParser()

3. 添加数据验证逻辑

add_argument()方法的参数:

第一个参数:验证的参数的名称,

第二个参数(location):传递验证数据的方式,

第三个参数(type):验证数据的逻辑。

        # 2. 添加验证参数
        # 第一个参数: 传递的参数的名称
        # 第二个参数(location): 传递参数的方式
        # 第三个参数(type): 验证参数的函数(可以自定义验证函数)
        parser.add_argument('username', location='args', type=str)

4. 开始数据验证

        # 3. 验证数据
        # args是一个字典
        args = parser.parse_args()

5. 获取验证后的数据

如果验证通过,获取到数据;如果验证不通过,获取到None。

        # 4. 获取验证后的数据
        username = args.get('username')

案例代码:

from flask import Flask
from flask_restful import Api, Resource
from flask_restful.reqparse import RequestParser

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

class IndexResource(Resource):

    def get(self):
        # 1. 创建RequestParser实例
        parser = RequestParser()

        # 2. 添加验证参数
        # 第一个参数: 传递的参数的名称
        # 第二个参数(location): 传递参数的方式
        # 第三个参数(type): 验证参数的函数(可以自定义验证函数)
        parser.add_argument('username', location='args', type=str)

        # 3. 验证数据
        # args是一个字典
        args = parser.parse_args()

        # 4. 获取验证后的数据
        username = args.get('username')

        return 'get ...{}'.format(username)

api.add_resource(IndexResource, '/')

if __name__ == '__main__':
    app.run()
  • 3
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Flask Restful Swagger是一种用于构建RESTful API和自动生成API文档的工具。 Flask是一个轻量级的Python Web框架,提供了构建Web应用程序所需的基本功能。而Flask RestfulFlask的扩展,它使得构建RESTful API更加简单和高效。 Swagger是一种用于描述和可视化RESTful API的工具,它使用JSON或YAML格式定义API的接口和参数,并生成交互式的API文档。 使用Flask Restful Swagger,我们可以在Flask框架中轻松创建和管理RESTful API,并自动生成API文档。通过定义API的路由、请求参数和响应结果,我们可以便地生成具有完整描述和示例的API文档。 Flask Restful Swagger提供了一系列装饰器和注解,用于定义API的路由和参数。我们可以使用@api.route装饰器定义API的路由,并使用@api.doc装饰器定义API的文档信息。通过注解和装饰器的结合,我们可以灵活地描述API的请求参数、响应结果以及其他相关信息。 在生成API文档时,Flask Restful Swagger会解析我们定义的API信息,并将其转换成Swagger所需的JSON或YAML格式。然后,Swagger将根据这些信息生成交互式的API文档,其中包含API的路由、请求式、请求参数、响应结果等详细信息。这使得我们可以便地查看和测试API的接口,并清楚地理解API的使用方法和功能。 总结来说,通过使用Flask Restful Swagger,我们可以在Flask框架中快速构建和管理RESTful API,并自动生成可交互的API文档。这不仅提高了API的开发效率,也便了API的使用者理解和测试API的接口。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值