flask-restful总结

Flask-RESTful是一个用于快速建立RESTful API接口的Flask扩展。使用Flask-RESTful能够很快速方便地建立一个RESTful风格的接口应用程序。

一、安装

pip install flask_restful

二、所有代码

from flask import Flask
from flask_restful import reqparse, abort, Api, Resource

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

TODOS = {
    'todo1': {'task': 'build'},
    'todo2': {'task': 'bui2'},
    'todo3': {'task': 'bui3'}
}

parser = reqparse.RequestParser()
parser.add_argument('task')

class Todo(Resource):
    def get(self, todo_id):
        return TODOS[todo_id]

    def delete(self, todo_id):
        del TODOS[todo_id]
        return '', 204

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


class TodoList(Resource):
    def get(self):
        return TODOS


api.add_resource(TodoList, '/todos')
api.add_resource(Todo, '/todos/<todo_id>')

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

三、代码说明

1）. 初始化
在当前程序初始化一个flask-restful的api实例:
api = Api(app)

2）. 定义资源类
资源类是restful接口的具体实现，须要继承Resource类。在类中能够定义get、post等符合restful规范的接口。

class Todo(Resource):
    def get(self, todo_id):
        return TODOS[todo_id]

    def delete(self, todo_id):
        del TODOS[todo_id]
        return '', 204

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

3). 参数解析
虽然 Flask 提供了简单的方法访问请求数据, 可是对于表单数据处理仍是比较麻烦. Flask-RESTful 提供了 reqparse 一种相似 argparse 参数解析机制以简化参数处理.
parser = reqparse.RequestParser()： reqparse使用RequestParser() 能够从 flask.Request.values，以及 flask.Request.json 解析值。这里建立了一个解析对象parser。
parser.add_argument('task')：向parser对象中添加你要关注的命令行参数和选项，每个add_argument方法对应一个你要关注的参数或选项。
parser.parse_args()：调用parse_args()方法进行解析，解析成功以后便可使用。

4). add_argument扩展
对于必传的参数，能够设置required=True

parser.add_argument('name', type=str, required=True,
help="Name cannot be blank!")

传多个值，使用 action='append'

parser.add_argument('name', type=str, action='append')
使用：
curl http://api.example.com -d "Name=bob" -d "Name=sue" -d "Name=joe"
获取的参数为：
args = parser.parse_args()
args['name']    # ['bob', 'sue', 'joe']