Python Flask Restful

Flask  Restful

 

1.flask restful

　　在flask基礎上進行一些封裝，主要用於實現restful接口

 

2.restful的理解

1）URI(統一資源標識符）：每一個URI代表一種資源，restful接口對資源進行增刪改查

2) 客戶端和服務器之間，傳遞這種資源的某種表現層

3）客戶端通過四個HTTP動詞（get、post、put、delete），對服務器資源進行操作，實現“表現層狀態轉化”

 

3.Flask Restful安裝

1)先安裝flask:

　　pip install flask

　　2)再安裝flask restful:

　　　　pip install flask-restful

 

4.HelloWorld

__author__ = 'zhizhi'
from flask import Flask
from flask_restful import Api,Resource#老版本flask中使用的是flask.ext中的Api,目前已經被flask_restful中的Api替代
app=Flask(__name__)
api=Api(app)

class HelloWorld(Resource):
    def get(self):
        return {"hello":"world"}

api.add_resource(HelloWorld,'/')

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

 

結果：

 

5.flask restful API官網示例

from flask import Flask
from flask.ext.restful import reqparse, abort, Api, Resource

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

TODOS = {
    'todo1': {'task': 'build an API'},
    'todo2': {'task': '?????'},
    'todo3': {'task': 'profit!'},
}


def abort_if_todo_doesnt_exist(todo_id):
    if todo_id not in TODOS:
        abort(404, message="Todo {} doesn't exist".format(todo_id))

parser = reqparse.RequestParser()
parser.add_argument('task', type=str)


# Todo
#   show a single todo item and lets you delete them
class Todo(Resource):
    def get(self, todo_id):
        abort_if_todo_doesnt_exist(todo_id)
        return TODOS[todo_id]

    def delete(self, todo_id):
        abort_if_todo_doesnt_exist(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


# TodoList
#   shows a list of all todos, and lets you POST to add new tasks
class TodoList(Resource):
    def get(self):
        return TODOS

    def post(self):
        args = parser.parse_args()
        todo_id = int(max(TODOS.keys()).lstrip('todo')) + 1
        todo_id = 'todo%i' % todo_id
        TODOS[todo_id] = {'task': args['task']}
        return TODOS[todo_id], 201

##
## Actually setup the Api resource routing here
##
api.add_resource(TodoList, '/todos')
api.add_resource(Todo, '/todos/<todo_id>')


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

 

6.官網示例的代碼解析

（1）引入需要的庫名、函數、變量等，並做簡單的Application初始化：

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

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

 

（2）定義我們需要操作的資源類型（都是json格式的）：

TODOS = {
    'todo1': {'task': 'build an API'},
    'todo2': {'task': '?????'},
    'todo3': {'task': 'profit!'},
}

（3)如果id不存在，則停止運行

def abort_if_todo_doesnt_exist(todo_id):
    if todo_id not in TODOS:
        abort(404, message="Todo {} doesn't exist".format(todo_id))

 

（4）Flask-RESTful提供了一個用於參數解析的RequestParser類，類似於Python中自帶的argparse類，可以很方便的解析請求中的-d參數，並進行類型轉換。

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

 

（5）API分為兩類：帶參數id的，和不帶有參數id的。前者是操作單一資源，后者是操作資源列表或新建一個資源。

從操作單一資源開始，繼承Resource類，並添加put / get / delete方法：

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

    def delete(self, todo_id):
        abort_if_todo_doesnt_exist(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

 

（6）繼續操作資源列表，繼承Resource類，並添加get / post方法：

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

    def post(self):
        args = parser.parse_args()
        todo_id = int(max(TODOS.keys()).lstrip('todo')) + 1
        todo_id = 'todo%i' % todo_id
        TODOS[todo_id] = {'task': args['task']}
        return TODOS[todo_id], 201

 

（7）資源操作類定義完畢之后，需要設置路由，即告訴Python程序URL的對應關系。

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