1. 程式人生 > >使用python的Flask實現一個簡單RESTful API伺服器端

使用python的Flask實現一個簡單RESTful API伺服器端

找了一篇教程學習了一下,為了加深印象照著寫了一遍存下來,原文連結如下:傳送門

REST的六個特性

  • Client-Server:伺服器端與客戶端分離。
  • Stateless(無狀態):每次客戶端請求必需包含完整的資訊,換句話說,每一次請求都是獨立的。
  • Cacheable(可快取):伺服器端必需指定哪些請求是可以快取的。
  • Layered System(分層結構):伺服器端與客戶端通訊必需標準化,伺服器的變更並不會影響客戶端。
  • Uniform Interface(統一介面):客戶端與伺服器端的通訊方法必需是統一的。
  • Code on demand(按需執行程式碼?):伺服器端可以在上下文中執行程式碼或者指令碼?

HTTP請求方法

  1. GET 請求指定的頁面資訊,並返回實體主體。
  2. HEAD 類似於get請求,只不過返回的響應中沒有具體的內容,用於獲取報頭
  3. POST 向指定資源提交資料進行處理請求(例如提交表單或者上傳檔案)。資料被包含在請求體中。POST請求可能會導致新的資源的建立和/或已有資源的修改。
  4. PUT 從客戶端向伺服器傳送的資料取代指定的文件的內容。
  5. DELETE 請求伺服器刪除指定的頁面。
  6. CONNECT HTTP/1.1協議中預留給能夠將連線改為管道方式的代理伺服器。
  7. OPTIONS 允許客戶端檢視伺服器的效能。
  8. TRACE 回顯伺服器收到的請求,主要用於測試或診斷。

規劃資源的URL

我們定義任務清單有以下欄位:
id:唯一標識。整型。
title:簡短的任務描述。字串型。
description:完整的任務描述。文字型。
done:任務完成狀態。布林值型。

程式碼實現以及註釋

#!flask/bin/python
# -*- coding:UTF-8 -*-
from flask import Flask, jsonify
from flask import make_response
from flask import request
from flask import abort

app = Flask(__name__)

tasks = [
    {
        'id'
: 1, 'title': u'Buy groceries', 'description': u'Milk, Cheese, Pizza, Fruit, Tylenol', 'done': False }, { 'id': 2, 'title': u'Learn Python', 'description': u'Need to find a good Python tutorial on the web', 'done': False } ] @app.route('/todo/api/v1.0/tasks', methods=['GET']) def get_tasks(): return jsonify({'tasks': tasks}) #通過引數,檢索tasks陣列。如果引數傳過來的id不存在於陣列內,我們需要返回錯誤程式碼404 #按照HTTP的規定,404意味著是"Resource Not Found",資源未找到。 #如果找到任務在記憶體陣列內,我們通過jsonify模組將字典打包成JSON格式 #併發送響應到客戶端上。就像處理一個實體字典一樣。 @app.route('/todo/api/v1.0/tasks/<int:task_id>', methods=['GET']) def get_task(task_id): task = filter(lambda t: t['id'] == task_id, tasks) if len(task) == 0: abort(404) return jsonify({'task':task[0]}) #使用post方法插入一個新的任務到陣列中 @app.route('/todo/api/v1.0/tasks', methods=['POST']) def create_task(): #request.jason裡面包含請求資料,如果不是JSON或者裡面沒有包含title欄位 if not request.json or not 'title' in request.json: abort(400) task = { 'id': tasks[-1]['id'] + 1, #task[-1]代表原來的最後一位 'title': request.json['title'], 'description': request.json.get('description', ""), 'done': False } tasks.append(task) return jsonify({'task': task}), 201 @app.errorhandler(404) def not_found(error): return make_response(jsonify({'error': 'Not found'}), 404) #更改資料 @app.route('/todo/api/v1.0/tasks/<int:task_id>', methods=['PUT']) def update_task(task_id): task = filter(lambda t: t['id'] == task_id, tasks) if len(task) == 0: abort(404) if not request.json: abort(400) if 'title' in request.json and type(request.json['title']) != unicode: abort(400) if 'description' in request.json and type(request.json['description']) is not unicode: abort(400) if 'done' in request.json and type(request.json['done']) is not bool: abort(400) task[0]['title'] = request.json.get('title', task[0]['title']) task[0]['description'] = request.json.get('description', task[0]['description']) task[0]['done'] = request.json.get('done', task[0]['done']) return jsonify({'task': task[0]}) #刪除資料 @app.route('/todo/api/v1.0/tasks/<int:task_id>', methods=['DELETE']) def delete_task(task_id): task = filter(lambda t: t['id'] == task_id, tasks) if len(task) == 0: abort(404) tasks.remove(task[0]) return jsonify({'result': True}) if __name__ == '__main__': app.run(debug=True)