1. 程式人生 > >Python flask模組介面開發學習總結

Python flask模組介面開發學習總結

引言

Flask 是一個簡單且十分強大的Python web 框架。它被稱為微框架,“微”並不是意味著把整個Web應用放入到一個Python檔案,微框架中的“微”是指Flask旨在保持程式碼簡潔且易於擴充套件,Flask框架的主要特徵是核心構成比較簡單,但具有很強的擴充套件性和相容性,程式設計師可以使用Python語言快速實現一個網站或 Web服務。因此flask能很方便構建一個web服務,給外部也可以叫做客戶端提供web服務,針對flask框架這種特點我們可以很容易構建API介面,供客戶端訪問。

Flask介面開發示例

首先安裝需要的Flask模組,如果你的環境已經安裝了pip則鍵入:pip install flask即可安裝完成

1.1 構建GET請求方法的介面

在Pycharm中新建py檔案,編輯如下程式碼

# -*- coding: utf-8 -*-
import flask,json
import time

server = flask.Flask(__name__)   # 建立一個服務,把當前這個python檔案當做一個服務

@server.route('/VIID/System/Time', methods=['get'])  # @server.route()可以將普通函式轉變為服務、介面的路徑、請求方式,如果不寫methods則預設get方法
def Time():
    '''查詢字串:無,訊息體:無,返回結果:SystemTime'''
    response_data = {
                "SystemTimeObject": {
                    "VIIDServerID": "123",
                    "TimeMode": "1",           
                    "LocalTime": time.strftime('%Y%m%d%H%M%S', time.localtime(time.time())),
                }
            }
    return json.dumps(response_data, ensure_ascii=False)

if __name__ == '__main__':
    server.run(debug=True, port=5000, host='10.82.25.11')  #  指定訪問埠、host

 然後執行該py檔案,則該檔案執行在本地就是一個web服務,用瀏覽器或者postman嘗試訪問該服務的URL即可

瀏覽器訪問:

postman發請求訪問:

瀏覽器或者postman請求完成後,在Pycharm的輸出欄會輸出如下:

其它的請求如POST、PUT、DELETE等方法,在methods引數中指明即可,不過POST、PUT、DELETE等方法不能由瀏覽器直接訪問,因為瀏覽器預設訪問時是get方法,可以用postman按指定的方法發請求

1.2 獲取帶json格式請求體的介面

有時客戶端傳送的請求是帶json格式的,這時需要獲取請求的json,編輯程式碼如下:

@server.route('/data',methods=['post'])
def post_json():
    if flask.request.is_json:
        print(flask.request.json)
        name = flask.request.json.get('name')            # 獲取json請求體的第一個引數的值
        age = flask.request.json.get('age')             # 獲取json請求體的第二個引數的值
        data = {'name':name,'age':age}
        return json.dumps(data,ensure_ascii=False)
    else:
        return json.dumps({'msg':'請傳json格式引數'},ensure_ascii=False)

 使用postman作為客戶端傳送帶json請求體的請求,如下圖:

1.3 獲取get請求中傳送的引數

flask提供的方法是:

 value = flask.request.args.get('name')           # 獲取get請求引數name的值

1.4 構建動態URL以及響應體的重定向

很多時候,客戶端請求的url是變化的,也就是帶有動態引數的,flask也是可以輕鬆的構建提供動態引數的url資源服務並重定向響應體,程式碼如下:

# -*- coding: utf-8 -*-
import flask,json
from flask import url_for,redirect

server = flask.Flask(__name__)   # 建立一個服務,把當前這個python檔案當做一個服務

@server.route('/data')
def data():                       #  返回data
    data = {
                'VideoSliceInfoObject': {
                    'VideoID': 'esse elit',
                    'AudioCodeFormat': 'commodo'
                }
    }
    return json.dumps(data, ensure_ascii=False)

@server.route('/data/<ID>/Info', methods=['post'])
def data_redirect(ID):
    return redirect(url_for('data', guest=ID))

if __name__ == '__main__':
    server.run(debug=True, port=5000, host='10.82.25.11')  #  指定訪問埠、host

 後面無論postman或者客戶端傳送的url中的ID引數是啥,都可以響應

1.5 重新構建響應頭和響應狀態碼

有時在與第三方系統對接時,需要返回攜帶響應頭訊息和指定的響應狀態碼,在flask中也是可以構建自定義的響應訊息的

# -*- coding: utf-8 -*-
import flask,json

server = flask.Flask(__name__)   # 建立一個服務,把當前這個python檔案當做一個服務

@server.route('/data',methods=['post'])
def post_json():
    if flask.request.is_json:
        print(flask.request.json)
        name = flask.request.json.get('name')            # 獲取json請求體的第一個引數的值
        age = flask.request.json.get('age')             # 獲取json請求體的第二個引數的值
        data = {'name':name,'age':age}
        # 構建響應頭域和狀態碼
        resp = flask.make_response(json.dumps(data, ensure_ascii=False))
        resp.status = "666"
        resp.headers[
            "python"] = "python flask"
        return resp
    else:
        return json.dumps({'msg':'請傳json格式引數'},ensure_ascii=False)

if __name__ == '__main__':
    server.run(debug=True, port=5000, host='10.82.25.11')  #  指定訪問埠、host

 執行該py檔案,在postman中傳送請求,檢視響應資訊,如下圖,變成的我們自定義設定的響應頭和狀態碼

這樣我們就完全自定義了響應的頭和狀