【Flask-RESTPlus系列】Part1：快速入門

 

0x00 內容概覽

1. Flask-RESTPlus安裝
2. 快速入門
   1. 初始化
   2. 一個最簡單的API示例
   3. 資源路由
   4. 端點
   5. 參數解析
   6. 數據格式化
   7. 順序保留
   8. 完整例子　

0x01 Flask-RESTPlus安裝

1、Python版本兼容性

當前Flask-RESTPlus的最新版本為v0.11.0，支持2.7或3.4+版本的Python。

2、安裝方式

可以通過以下幾種方式來安裝：

pip安裝：$ pip install flask-restplus

easy_install安裝：$ easy_install flask-restplus

離線安裝：首先下載flask-restplus包，然后本地解壓切換到包目錄，使用python setup.py install安裝

安裝開發版：

git clone https://github.com/noirbizarre/flask-restplus.git
cd flask-restplus
pip install -e .[dev,test]

0x02 快速入門

 本教程假設你已經熟悉了Flask，並已經正常安裝了Flask和Flask-RESTPlus。如果還未安裝Flask-RESTPlus，那么請參考0x01部分進行安裝。

1、初始化

在使用Flask-RESTPlus之前，需要進行初始化，這一點與Flask的其他擴展是一樣的，通過傳入Flask實例進行初始化：

from flask import Flask
from flask_restplus import Api

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

或者使用工廠模式進行初始化：

from flask import Flask
from flask_restplus import Api

api = Api()

app = Flask(__name__)
api.init_app(app)

2、一個最簡單的API示例

一個最簡單的API示例程序如下：

# file:1-Quick-Start.py

from flask import Flask
from flask_restplus import Resource, Api

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

@api.route('/hello')
class HelloWorld(Resource):
    def get(self):
        return {'hello': 'world'}

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

需要注意的是，此時在程序中我們開啟了Flask的調試模式，即設置了debug=True，這是為了更詳細地打印錯誤信息，以及確保我們每次修改代碼時，都會自動發現變更並重新啟動運行最新的代碼。不過，生產環境絕對不要開啟調試模式，因為它會使你的后台服務處於被攻擊的風險之中！

此時在PyCharm中運行該程序，正常情況下會打印出以下信息：

C:\SelfFiles\Install\Python36\python.exe C:/SelfFiles/Codes/Python/codes/Flask-RESTPlus-Tutorial/1_Quick_Start/1-Quick-Start.py
* Restarting with stat
* Debugger is active!
* Debugger PIN: 156-529-095
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

此時在瀏覽器中訪問http://127.0.0.1:5000/hello會返回以下結果：

或者使用curl工具進行訪問：

另外，我們也可以在瀏覽器中直接訪問我們API的根路徑，即http://127.0.0.1:5000，此時會顯示Swagger的界面，里面包含了我們的Restful API的相應信息，這就是Flask-RESTPlus的強大之處（當然，其實是Swagger的強大之處）：

 3、資源路由

 Flask-RESTPlus提供的主要創建對象就是資源。資源創建於Flask可插入視圖（pluggable view）之上，使得我們可以通過在資源上定義方法來很容易地訪問多個HTTP方法。下面是一個對todo應用的基本CRUD資源操作的示例：

from flask import Flask, request
from flask_restplus import Resource, Api

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

todos = {}

@api.route('/<string:todo_id>')
class TodoSimple(Resource):
    def get(self, todo_id):
        return {todo_id: todos[todo_id]}

    def put(self, todo_id):
        todos[todo_id] = request.form['data']
        return {todo_id: todos[todo_id]}

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

可以通過curl對其進行訪問操作：

或者，如果你的Python中安裝了Requests包，那也也可以使用它來進行訪問：

Flask-RESTPlus理解視圖方法中的多種類型的返回值。類似於Flask，你可以返回任何可迭代的類型，它會將該返回值轉換成響應對象（response），包括原始的Flask響應對象。Flask-RESTPlus還提供了設置響應碼和響應頭的功能，這一點可以通過使用多個返回值來實現，如下所示：

class Todo1(Resource):
    def get(self):
        # 默認為200 OK
        return {'task': 'Hello world'}

class Todo2(Resource):
    def get(self):
        # 設置響應碼為201
        return {'task': 'Hello world'}, 201

class Todo3(Resource):
    def get(self):
        # 設置響應碼為201，並返回自定義的響應頭
        return {'task': 'Hello world'}, 201, {'Etag': 'some-opaque-string'}

4、端點（Endpoints）

大多數情況下，某個資源都會有多個URL。所以，我們可以向Api對象的add_resource()方法或route()裝飾器中傳入多個URL，這樣每個URL都將會路由到該資源上：

api.add_resource(HelloWorld, '/hello', '/world')

# 或者下面裝飾器方式，二者等價

@api.route('/hello', '/world')
class HelloWorld(Resource):
    pass

另外，也可以將URL中的部分內容設置成變量，以此來匹配資源方法，如下所示：

api.add_resource(Todo, '/todo/<int:todo_id>', endpoint='todo_ep')

# 或者下面裝飾器方式，二者等價

@api.route('/todo/<int:todo_id>', endpoint='todo_ep')
class HelloWorld(Resource):
    pass

# 這樣，URL為/todo/1、/todo/2等以/todo/加一個int型整數的URL都可以路由到該資源

注意：如果一個請求（request）與應用的任何端點都不匹配，那么Flask-RESTPlus將會返回一個404錯誤信息，並給出其他與所請求端點最匹配的建議信息。不過，我們可以通過在程序配置中設置ERROR_404_HELP為False來關閉該功能。

未關閉時程序如下：

from flask import Flask, request
from flask_restplus import Resource, Api

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


todos = {}

@api.route('/<string:todo_id>')
class TodoSimple(Resource):
    def get(self, todo_id):
        return {todo_id: todos[todo_id]}

    def put(self, todo_id):
        todos[todo_id] = request.form['data']
        return {todo_id: todos[todo_id]}

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

運行改程序並在瀏覽器中訪問http://localhost:5000/hello/hello，結果如下：

設置ERROR_404_HELP為False后的程序為：

from flask import Flask, request
from flask_restplus import Resource, Api

app = Flask(__name__)
api = Api(app)
app.config['ERROR_404_HELP'] = False  7 
todos = {}

@api.route('/<string:todo_id>')
class TodoSimple(Resource):
    def get(self, todo_id):
        return {todo_id: todos[todo_id]}

    def put(self, todo_id):
        todos[todo_id] = request.form['data']
        return {todo_id: todos[todo_id]}

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

再次運行並訪問http://localhost:5000/hello/hello，結果如下：

 

此處兩種情況返回結果一致，尚未嘗試出給出相近端點的建議信息，也許是我沒用使用對，后續再補充。

5、參數解析（Argument Parsing） 

盡管Flask提供了容易的方式來訪問請求數據（例如，查詢字符串querystring或者POST表單編碼數據），但驗證表單數據仍舊是一件令人頭疼的事。Flask-RESTPlus內置支持對請求數據的驗證，這一功能是通過使用一個類似於argparse的庫來實現的，如下：

from flask_restplus import reqparse

parser = reqparse.RequestParser()
parser.add_argument('rate', type=int, help='Rate to charge for this resource')
args = parser.parse_args()

注意：與argparse模塊不同的是，parse_args()返回的是一個Python字典，而不是自定義數據結構。

使用RequestParser類還能獲取完整的錯誤信息。如果一個參數未驗證通過，Flask-RESTPlus將響應一個400壞請求，以及一個高亮錯誤信息的響應。示例程序如下：

from flask import Flask, request
from flask_restplus import Resource, Api,reqparse

app = Flask(__name__)

api = Api(app)

from flask_restplus import reqparse

parser = reqparse.RequestParser()
parser.add_argument('rate', type=int,required=True,help='Rate to charge for this resource')


todos = {
    '1':'eat',
    '2':'sleep'
}

@api.route('/<string:todo_id>')
class TodoSimple(Resource):
    def get(self, todo_id):
        return {todo_id: todos[todo_id]}

    def put(self, todo_id):
        args = parser.parse_args()
        todos[todo_id] = request.form['data']
        return {todo_id: todos[todo_id]}

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

其中，parser.add_argument('rate', type=int,required=True,help='Rate to charge for this resource')表示，參數名為rate，數據類型為int，請求時必須發送此參數，如果驗證不通過時將會返回help指定的信息。

運行程序並使用curl進行訪問，分別驗證以下幾種情況：

• 提供rate值，但不是int型（驗證不通過）
• 提供rate值，且是int型（驗證通過）
• 不提供rate值（驗證不通過）

結果分別如下：

另外，以參數strict=True調用parse_args()能夠保證如果請求中包含了解析器中未定義的參數時，將會拋出一個錯誤。示例程序如下：

from flask import Flask, request
from flask_restplus import Resource, Api,reqparse

app = Flask(__name__)

api = Api(app)

from flask_restplus import reqparse

parser = reqparse.RequestParser()
parser.add_argument('rate', type=int,required=True,help='Rate to charge for this resource')


todos = {
    '1':'eat',
    '2':'sleep'
}

@api.route('/<string:todo_id>')
class TodoSimple(Resource):
    def get(self, todo_id):
        return {todo_id: todos[todo_id]}

    def put(self, todo_id):
        args = parser.parse_args(strict=True)
        todos[todo_id] = todo_id
        return {todo_id: todos[todo_id]}

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

此時，運行該程序並使用curl訪問，結果如下：

 6、數據格式化（Data Formatting）

默認情況下，在返回的可迭代對象中的所有字段都會原樣返回。雖然在處理Python基本數據結構時這種方式很不錯，但是當涉及到對象時將會變得非常棘手。為了解決這個問題，Flask-RESTPlus提供了fields模塊和marshal_with()裝飾器。類似於Django ORM和WTForm，你可以使用fields模塊來描述響應的數據結構。示例程序如下：

from flask import Flask
from flask_restplus import fields, Api, Resource

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

model = api.model('Model', {
    'task': fields.String,
    'uri': fields.Url('todo_ep',absolute=True) # absolute參數表示生成的url是否是絕對路徑
})

class TodoDao(object):
    def __init__(self, todo_id, task):
        self.todo_id = todo_id
        self.task = task

        # 該字段不會發送到響應結果中
        self.status = 'active'

@api.route('/todo',endpoint='todo_ep')
class Todo(Resource):
    @api.marshal_with(model)
    def get(self, **kwargs):
        return TodoDao(todo_id='my_todo', task='Remember the milk')

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

運行上述程序並使用curl訪問結果如下：

上述示例接受了一個Python對象，並將其進行結構轉換。而marshal_with()裝飾器就是用來對結果按照model的結構進行轉換的，從上面的結果和代碼中可以知道，我們僅僅從TodoDao對象中提取了task字段的值，而model中的fields.Url字段是一個特殊字段，它接受一個端點名，並在響應中生成該端點名對應的URL。此外，使用marshal_with()裝飾器還可以以swagger規范對輸出進行歸檔。fields模塊中包含了你所需要的大多數類型，詳細信息可以查看fields模塊的說明文檔。

7、順序保留

 默認情況下，字段順序並未得到保留，因為它會損耗性能。不過，如果你確實需要保留字段順序，那么可以向類或函數傳入一個ordered=True的參數項，以此強制進行順序保留：

• Api全局保留：api = Api(ordered = True)
• Namespace全局保留：ns = Namespace(ordered=True)
• marshal()局部保留：return marshal(data, fields, ordered=True)

本例中只舉例局部保留方式的使用方法，程序如下：

from flask import Flask
from flask_restplus import fields, Api, Resource

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

model = api.model('Model', {
    'task': fields.String,
    'uri': fields.Url('todo_ep',absolute=True), # absolute參數表示生成的url是否是絕對路徑
    'developer':fields.String(default='jack')
})

class TodoDao(object):
    def __init__(self, todo_id, task, developer):
        self.todo_id = todo_id
        self.task = task
        self.developer = developer

        # 該字段不會發送到響應結果中
        self.status = 'active'

@api.route('/todo',endpoint='todo_ep')
class Todo(Resource):
    # @api.marshal_with(model)
    def get(self, **kwargs):
        return api.marshal(TodoDao(todo_id='my_todo', task='Remember the milk', developer='Tom'),model,ordered=False)

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

運行並使用curl進行訪問，結果如下：

8、完整例子

from flask import Flask
from flask_restplus import Api, Resource, fields
from werkzeug.contrib.fixers import ProxyFix

app = Flask(__name__)
app.wsgi_app = ProxyFix(app.wsgi_app)

api = Api(app, version='1.0', title='TodoMVC API',
    description='A simple TodoMVC API',
)

# 定義命名空間
ns = api.namespace('todos', description='TODO operations')

todo = api.model('Todo', {
    'id': fields.Integer(readOnly=True, description='The task unique identifier'),
    'task': fields.String(required=True, description='The task details')
})


class TodoDAO(object):
    def __init__(self):
        self.counter = 0
        self.todos = []

    def get(self, id):
        for todo in self.todos:
            if todo['id'] == id:
                return todo
        api.abort(404, "Todo {} doesn't exist".format(id))

    def create(self, data):
        todo = data
        todo['id'] = self.counter = self.counter + 1
        self.todos.append(todo)
        return todo

    def update(self, id, data):
        todo = self.get(id)
        todo.update(data)
        return todo

    def delete(self, id):
        todo = self.get(id)
        self.todos.remove(todo)


DAO = TodoDAO()
DAO.create({'task': 'Build an API'})
DAO.create({'task': '?????'})
DAO.create({'task': 'profit!'})


@ns.route('/')
class TodoList(Resource):
    '''獲取所有todos元素，並允許通過POST來添加新的task'''
    @ns.doc('list_todos')
    @ns.marshal_list_with(todo)
    def get(self):
        '''返回所有task'''
        return DAO.todos

    @ns.doc('create_todo')
    @ns.expect(todo)
    @ns.marshal_with(todo, code=201)
    def post(self):
        '''創建一個新的task'''
        return DAO.create(api.payload), 201


@ns.route('/<int:id>')
@ns.response(404, 'Todo not found')
@ns.param('id', 'The task identifier')
class Todo(Resource):
    '''獲取單個todo項，並允許刪除操作'''
    @ns.doc('get_todo')
    @ns.marshal_with(todo)
    def get(self, id):
        '''獲取id指定的todo項'''
        return DAO.get(id)

    @ns.doc('delete_todo')
    @ns.response(204, 'Todo deleted')
    def delete(self, id):
        '''根據id刪除對應的task'''
        DAO.delete(id)
        return '', 204

    @ns.expect(todo)
    @ns.marshal_with(todo)
    def put(self, id):
        '''更新id指定的task'''
        return DAO.update(id, api.payload)


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

 更多其他示例參考GitHub。

0x03 參考鏈接

• http://flask-restplus.readthedocs.io/en/stable/quickstart.html
• http://flask-restplus.readthedocs.io/en/stable/example.html