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']