zoukankan      html  css  js  c++  java
  • Flask-RESTful扩展

    Flask-RESTful扩展

    我们了解到Flask路由可以指定HTTP请求方法,并在请求函数中根据不同的请求方法,执行不同的逻辑。这样实现一个Restful的请求已经相当简单了。但是Flask还有更简便的方法,就是其Flask-RESTful扩展。首先,我们来安装这个扩展:

    $ pip install Flask-RESTful
    

    安装完后,你就可以在代码中导入该扩展包flask.ext.restful。让我们来看个例子:

    from flask import Flask, request
    from flask.ext.restful import Api, Resource
    
    app = Flask(__name__)
    api = Api(app)
    
    USER_LIST = {
        '1': {'name':'Michael'},
        '2': {'name':'Tom'},
    }
    
    class UserList(Resource):
        def get(self):
            return USER_LIST
    
        def post(self):
            user_id = int(max(USER_LIST.keys())) + 1
            user_id = '%i' % user_id
            USER_LIST[user_id] = {'name': request.form['name']}
            return USER_LIST[user_id]
    
    api.add_resource(UserList, '/users')
    
    if __name__ == '__main__':
        app.run(host='0.0.0.0', debug=True)
    

    这个例子很容易理解,Restful扩展通过api.add_resource()方法来添加路由,方法的第一个参数是一个类名,该类继承Resource基类,其成员函数定义了不同的HTTP请求方法的逻辑;第二个参数定义了URL路径。运行上面的例子并访问http://localhost:5000/users,GET请求时会列出全局变量USER_LIST中的内容,POST请求时会在USER_LIST中添加一项,并返回刚添加的项。如果在POST请求中找不到name字段,则返回”400 Bad Request”错误。由于类UserList没有定义put()delete()函数,所以在”PUT”或”DELETE”请求时会返回”405 Method Not Allowed”错误。

    另外,路由支持多路径,比如:

    api.add_resource(UserList, '/userlist', '/users')
    

    这样访问http://localhost:5000/userlisthttp://localhost:5000/users的效果完全一样。

    带参数的请求

    上面的例子请求是针对user列表的,如果我们要对某个具体的user做操作,就需要传递具体的user_id了。这时候,我们需要路由支持带参数。Flask-RESTful的实现同Flask一样,就是在路由中加上参数变量即可。我们看下例子:

    class User(Resource):
        def get(self, user_id):
            return USER_LIST[user_id]
    
        def delete(self, user_id):
            del USER_LIST[user_id]
            return ''
    
        def put(self, user_id):
            USER_LIST[user_id] = {'name': request.form['name']}
            return USER_LIST[user_id]
    
    api.add_resource(User, '/users/<user_id>')
    

    api.add_resource()的第二个参数路径中加上URL参数变量即可,格式同入门系列第二篇Flask路由中完全一样,也支持转换器来转换变量类型。此外,在User类的get()post()put()等成员函数中,记得加上参数user_id来获取传入的变量值。

    参数解析

    在”POST”或”PUT”请求中,直接访问form表单并验证的工作有些麻烦。Flask-RESTful提供了reqparse库来简化。我们来改进下上例中的”PUT”函数:

    from flask.ext.restful import reqparse
    
    parser = reqparse.RequestParser()
    parser.add_argument('name', type=str)
    
    class User(Resource):
        def put(self, user_id):
            args = parser.parse_args()
            USER_LIST[user_id] = {'name': args['name']}
            return USER_LIST[user_id]
    

    你可以通过parser.add_argument()方法来定义form表单字段,并指定其类型(本例中是字符型str)。然后在put()函数中,就可以调用parser.parse_args()来获取表单内容,并返回一个字典,该字典就包含了表单的内容。parser.parse_args()方法会自动验证数据类型,并在类型不匹配时,返回400错误。你还可以添加strict参数,如parser.parse_args(strict=True),此时如果请求中出现未定义的参数,也会返回400错误。

    示例代码

    结合上述的内容,我们来看一个完整的例子:

    from flask import Flask
    from flask.ext.restful import Api, Resource, reqparse, abort
    
    app = Flask(__name__)
    api = Api(app)
    
    USER_LIST = {
        1: {'name':'Michael'},
        2: {'name':'Tom'},
    }
    
    parser = reqparse.RequestParser()
    parser.add_argument('name', type=str)
    
    def abort_if_not_exist(user_id):
        if user_id not in USER_LIST:
            abort(404, message="User {} doesn't exist".format(user_id))
    
    class User(Resource):
        def get(self, user_id):
            abort_if_not_exist(user_id)
            return USER_LIST[user_id]
    
        def delete(self, user_id):
            abort_if_not_exist(user_id)
            del USER_LIST[user_id]
            return '', 204
    
        def put(self, user_id):
            args = parser.parse_args(strict=True)
            USER_LIST[user_id] = {'name': args['name']}
            return USER_LIST[user_id], 201
    
    class UserList(Resource):
        def get(self):
            return USER_LIST
    
        def post(self):
            args = parser.parse_args(strict=True)
            user_id = int(max(USER_LIST.keys())) + 1
            USER_LIST[user_id] = {'name': args['name']}
            return USER_LIST[user_id], 201
    
    api.add_resource(UserList, '/users')
    api.add_resource(User, '/users/<int:user_id>')
    
    if __name__ == '__main__':
        app.run(host='0.0.0.0', debug=True)
    
  • 相关阅读:
    7、css基本选择器、层叠样式
    6、表格标签及表单标签
    5、head内常用标签
    4、body内常用符号
    3、HTML简介
    2、HTTP协议
    Mbedtls和Opesnssl 解码x509Certificate
    Django 学习5--DetailView
    Django 学习四--bootstrap
    Django 学习3--CreateView
  • 原文地址:https://www.cnblogs.com/liuweida/p/12299264.html
Copyright © 2011-2022 走看看