Flash做RESTful API的優(yōu)勢(shì)

Flask是一個(gè)使用Python開發(fā)的基于Werkzeug的Web框架焙压。
Flask非常適合于開發(fā)RESTful API蝌焚，因?yàn)樗哂幸韵绿攸c(diǎn)：
1.使用Python進(jìn)行開發(fā)钻洒，Python簡(jiǎn)潔易懂
2.容易上手
3.靈活
4.可以部署到不同的環(huán)境
5.支持RESTful請(qǐng)求分發(fā)
我一般是用curl命令進(jìn)行測(cè)試遭殉，除此之外杀捻，還可以使用Chrome瀏覽器的postman擴(kuò)展刁标。

image.png

測(cè)試應(yīng)用

首先颠通，創(chuàng)建一個(gè)完整的應(yīng)用，支持響應(yīng)/, /tests以及/test/:id膀懈。

from flask import Flask, url_for
app = Flask(__name__)

@app.route('/')
def api_test():
    return 'hello word!'

@app.route('/tests')
def api_tests():
    return 'List of ' + url_for('api_tests')

@app.route('/test/<testid>')
def api_testes(testid):
    return 'You are reading ' + testid

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

url_for('function_name') 返回function的路由顿锰。
可以使用curl命令發(fā)送請(qǐng)求：

GET /
hello word!

GET /tests
List of /tests

GET /test/111
You are reading 111

路由中還可以使用類型定義:

@app.route('/test/<testid>')

上面的路由可以替換成下面的例子：

@app.route('/articles/<int:testid>')
@app.route('/articles/<float:testid>')
@app.route('/articles/<path:testid>')

請(qǐng)求REQUESTS

請(qǐng)求參數(shù)

假設(shè)需要響應(yīng)一個(gè)/hello請(qǐng)求，使用get方法启搂，并傳遞參數(shù)name

from flask import request,Flask
app = Flask(__name__)
@app.route('/hello')
def api_hello():
    if 'name' in request.args:
        return 'Hello ' + request.args['name']
    else:
        return 'Hello John Doe'

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

服務(wù)器會(huì)返回如下響應(yīng)信息：

GET /hello
Hello John Doe

GET /hello?name=xiaokai
Hello xiaokai

請(qǐng)求方法

Flask支持不同的請(qǐng)求方法：

from flask import request,Flask
app = Flask(__name__)
@app.route('/echo', methods = ['GET', 'POST', 'PATCH', 'PUT', 'DELETE'])
def api_echo():
    if request.method == 'GET':
        return "ECHO: GET\n"

    elif request.method == 'POST':
        return "ECHO: POST\n"

    elif request.method == 'PATCH':
        return "ECHO: PACTH\n"

    elif request.method == 'PUT':
        return "ECHO: PUT\n"

    elif request.method == 'DELETE':
        return "ECHO: DELETE"
if __name__ == '__main__':
    app.run()

可以使用如下命令進(jìn)行測(cè)試:

curl -X PATCH http://127.0.0.1:5000/echo

請(qǐng)求數(shù)據(jù)REQUEST和請(qǐng)求頭request.headers

通常使用POST方法和PATCH方法的時(shí)候硼控，都會(huì)發(fā)送附加的數(shù)據(jù)，這些數(shù)據(jù)的格式可能如下：普通文本(plain text)胳赌， JSON牢撼，XML，二進(jìn)制文件或者用戶自定義格式疑苫。
Flask中使用request.headers類字典對(duì)象來(lái)獲取請(qǐng)求頭信息熏版，使用request.data獲取請(qǐng)求數(shù)據(jù)，如果發(fā)送類型是application/json捍掺，則可以使用request.get_json()來(lái)獲取JSON數(shù)據(jù)撼短。

from flask import request,Flask
from flask import json
app = Flask(__name__)

@app.route('/messages', methods = ['POST'])
def api_message():

    if request.headers['Content-Type'] == 'text/plain':
        return "Text Message: " + request.data

    elif request.headers['Content-Type'] == 'application/json':
        return "JSON Message: " + json.dumps(request.json)

    elif request.headers['Content-Type'] == 'application/octet-stream':
        f = open('./binary', 'wb')
        f.write(request.data)
        f.close()
        return "Binary message written!"
    else:
        return "415 Unsupported Media Type ;)"
if __name__ == '__main__':
    app.run()

使用如下命令指定請(qǐng)求數(shù)據(jù)類型進(jìn)行測(cè)試：

curl -H "Content-type: application/json" \
-X POST http://127.0.0.1:5000/messages -d '{"message":"Hello Data"}'

注意Flask可以通過(guò)request.files獲取上傳的文件，curl可以使用-F選項(xiàng)模擬上傳文件的過(guò)程乡小。

響應(yīng)RESPONSES

Flask使用Response類處理響應(yīng)。

from flask import Flask

app = Flask(__name__)

from flask import Response

@app.route('/hello', methods = ['GET'])
def api_hello():
    data = {
        'hello'  : 'world',
        'number' : 3
    }
    js = json.dumps(data)

    resp = Response(js, status=200, mimetype='application/json')
    resp.headers['Link'] = 'http://luisrei.com'

    return resp
if __name__ == '__main__':
    app.run()s

使用-i選項(xiàng)可以獲取響應(yīng)信息：

curl -i http://127.0.0.1:5000/hello

相應(yīng)結(jié)果：

GET /hello
HTTP/1.0 200 OK
Content-Type: application/json
Content-Length: 31
Link: http://luisrei.com
Server: Werkzeug/0.8.2 Python/2.7.1
Date: Wed, 25 Apr 2012 16:40:27 GMT
{"hello": "world", "number": 3}
   om flask import jsonify
...
# 將下面的代碼替換成
resp = Response(js, status=200, mimetype='application/json')
# 這里的代碼
resp = jsonify(data)
resp.status_code = 200

狀態(tài)碼和錯(cuò)誤處理

成功響應(yīng)的話饵史，狀態(tài)碼為200满钟。對(duì)于404錯(cuò)誤我們可以這樣處理：

@app.errorhandler(404)
def not_found(error=None):
   message = {
           'status': 404,
           'message': 'Not Found: ' + request.url,
   }
   resp = jsonify(message)
   resp.status_code = 404

   return resp

@app.route('/users/<userid>', methods = ['GET'])
def api_users(userid):
   users = {'1':'john', '2':'steve', '3':'bill'}

   if userid in users:
       return jsonify({userid:users[userid]})
   else:
       return not_found()

測(cè)試上面的兩個(gè)URL，結(jié)果如下：

GET /users/2
HTTP/1.0 200 OK
{
    "2": "steve"
}

GET /users/4
HTTP/1.0 404 NOT FOUND
{
"status": 404, 
"message": "Not Found: http://127.0.0.1:5000/users/4"
}

默認(rèn)的Flask錯(cuò)誤處理可以使用@error_handler修飾器進(jìn)行覆蓋或者使用下面的方法：

app.error_handler_spec[None][404] = not_found

即使API不需要自定義錯(cuò)誤信息胳喷，最好還是像上面這樣做湃番，因?yàn)镕lask默認(rèn)返回的錯(cuò)誤信息是HTML格式的。

認(rèn)證

使用下面的代碼可以處理 HTTP Basic Authentication

from functools import wraps

def check_auth(username, password):
    return username == 'admin' and password == 'secret'

def authenticate():
    message = {'message': "Authenticate."}
    resp = jsonify(message)

    resp.status_code = 401
    resp.headers['WWW-Authenticate'] = 'Basic realm="Example"'

    return resp

def requires_auth(f):
    @wraps(f)
    def decorated(*args, **kwargs):
        auth = request.authorization
        if not auth: 
            return authenticate()

        elif not check_auth(auth.username, auth.password):
            return authenticate()
        return f(*args, **kwargs)

    return decorated

接下來(lái)只需要給路由增加@require_auth修飾器就可以在請(qǐng)求之前進(jìn)行認(rèn)證了：

@app.route('/secrets')
@requires_auth
def api_hello():
    return "Shhh this is top secret spy stuff!"

現(xiàn)在吭露，如果沒(méi)有通過(guò)認(rèn)證的話吠撮，響應(yīng)如下所示：

GET /secrets
HTTP/1.0 401 UNAUTHORIZED
WWW-Authenticate: Basic realm="Example"
{
  "message": "Authenticate."
}

curl通過(guò)-u選項(xiàng)來(lái)指定HTTP basic authentication，使用-v選項(xiàng)打印請(qǐng)求頭：

curl -v -u "admin:secret" http://127.0.0.1:5000/secrets

響應(yīng)結(jié)果如下：

GET /secrets Authorization: Basic YWRtaW46c2VjcmV0
Shhh this is top secret spy stuff!

Flask使用MultiDict來(lái)存儲(chǔ)頭部信息讲竿，為了給客戶端展示不同的認(rèn)證機(jī)制泥兰，可以給header添加更多的WWW-Autheticate。

resp.headers['WWW-Authenticate'] = 'Basic realm="Example"'resp.headers.add('WWW-Authenticate', 'Bearer realm="Example"')

調(diào)試與日志

通過(guò)設(shè)置debug=True來(lái)開啟調(diào)試信息：

app.run(debug=True)

使用Python的logging模塊可以設(shè)置日志信息：

import logging
file_handler = logging.FileHandler('app.log')
app.logger.addHandler(file_handler)
app.logger.setLevel(logging.INFO)

@app.route('/hello', methods = ['GET'])
def api_hello():
    app.logger.info('informing')
    app.logger.warning('warning')
    app.logger.error('screaming bloody murder!')

    return "check your logs\n"

稍后繼續(xù)
參考：http://python.jobbole.com/85390/