使用Flask開發簡單接口(1)--GET請求接口

前言

很多想學習接口測試的同學，可能在最開始的時候，常常會因沒有可以練習的項目而苦惱，畢竟網上可以練習的接口項目不多，有些可能太簡單了，有些可能又太復雜了，或者是網上一些免費接口請求次數有限制，最終導致這些同學遲遲無法進行實踐。

就拿我以前在練習JMeter時所用到的接口（相關鏈接：Jmeter接口測試實例-牛刀小試
），因為是網上別人開發的接口，有時候經常因各種原因導致無法正常使用，於是，我就想到為什么不可以自己開發一個簡單的接口項目，來滿足平常的練習呢？

因為目前使用Python比較廣泛，考慮到Django比較笨重性，而我目前畢竟只是想開發一些簡單接口，於是我選擇了Flask。Flask是一個使用 Python 編寫的輕量級 Web 應用框架，它非常容易上手，我們准備使用它來開發一個簡單的接口項目。

安裝Flask

在Python下，可以直接通過 pip 工具來進行安裝，而在我環境下因為同時安裝了python2和python3，所以用 pip3 來區分，安裝命令：pip3 install Flask，如果想要查看當前Flask版本信息，可以使用命令：pip3 show flask，我目前使用的版本是 1.0.3 。

[root@wintest ~]# pip3 show flask
Name: Flask
Version: 1.0.3
Summary: A simple framework for building complex web applications.
Home-page: https://www.palletsprojects.com/p/flask/
Author: Armin Ronacher
Author-email: [e-mail]
License: BSD
Location: /root/python36/lib/python3.6/site-packages
Requires: itsdangerous, Jinja2, click, Werkzeug
Required-by: 
[root@wintest ~]# 

為了更好的學習Flask，我們可以在網上找到Flask的官方文檔和中文文檔，以便進一步學習。

Flask官方文檔（1.0.x版本）：https://flask.palletsprojects.com/en/1.0.x/
Flask中文文檔（最新版）：https://dormousehole.readthedocs.io/en/latest/

最簡單的應用

from flask import Flask
app = Flask(__name__)

@app.route('/')
def hello_world():
    return 'Hello, World!'

上面是Flask官方提供的一個最簡單的Flask應用，在PyCharm中，我們點擊左上方的 file，選擇 New Project，創建一個Flask項目。

在創建的項目中，會存在一個 app.py 文件，該文件里便包含了最簡單的Flask應用代碼。

我們執行代碼啟動Flask應用，可以看到如下信息：

可以發現，Flask應用的默認端口是 5000，我們打開本地瀏覽器，輸入 http://127.0.0.1:5000/，便可以看到在界面上顯示一行內容：Hello World!。

這是一個最簡單的接口，用Flask實現只用了5行代碼，可見Flask上手起來並不難。接下來，我們將會使用Flask來開發2個GET接口：獲取所有用戶信息接口和獲取某個用戶信息接口。

准備請求的用戶數據

我們創建一個 Python包 ，包名設置為 api ，表示將用於存放后續編寫的接口。在該包下新建一個 user.py 文件，這個文件用於編寫用戶相關的接口。

data = [
    {"id": 1, "username": "小明", "password": "123456", "role": 0, "sex": 0, "telephone": "10086", "address": "北京市海淀區"},
    {"id": 2, "username": "李華", "password": "abc", "role": 1, "sex": 0, "telephone": "10010", "address": "廣州市天河區"},
    {"id": 3, "username": "大白", "password": "666666", "role": 0, "sex": 1, "telephone": "10000", "address": "深圳市南山區"}
]

上面是我們准備的用戶數據，因為我們暫沒用到數據庫，所以自己定義了一個列表，列表下存放多個用戶信息，而每個用戶信息，則通過字典來存儲。每個字典均含有 id、username、password、telphone、address 等鍵名和鍵值。

通過jsonify返回JSON格式數據

我們在接口返回數據時，我們會定義一個字典，設置了接口返回碼code、接口返回信息msg、返回數據實體data，用字典將這幾個數據存儲，並返回顯示到頁面上。

如果我們直接把這個定義的字典返回，在請求的時候就會出現報錯：TypeError: 'dict' object is not callable，為解決這個問題，我們需要將這樣的字典數據轉換為JSON字符串，然后才能正常向頁面返回。

一般情況，要返回JSON格式數據，我們可以直接使用 json 模塊的 json.dumps() 方法，將字典轉換為json字符串，然后返回 。

# 使用python的json模塊
import json
json.dumps({"code":"0", "msg":"操作成功", "data":data})

但在Flask中，提供了jsonify方法供用戶處理返回的序列化json數據，我們可以直接導入該方法並進行使用。

# 使用Flask的jsonify方式
from flask import Flask,jsonify
jsonify({"code":"0", "msg":"操作成功", "data":data})

在這里，我們將直接使用Flask的jsonify方式來處理返回的數據，需要注意的一點，使用該方法會把返回的 Content-Type 從 text/html 轉換成帶json特征的 application/json。

獲取所有用戶信息接口

@app.route("/users", methods=["GET"])
def get_all_users():
    """獲取所有用戶信息"""
    return jsonify({"code":"0", "data":data, "msg":"操作成功"})

這里的代碼表示，當我們在請求路徑為 /users ，且請求方法為GET方式時，才會執行 get_all_users 接口，最后才能返回JSON數據。

Flask的請求默認是GET請求，也就是說 @app.route() 中，我們可以不寫 methods 參數，但這樣只能通過GET方式來發出請求。如果需要支持其他的請求方式，那么這里的 methods 需要寫成一個列表，當然也可以同時支持 GET、POST等請求方式，比如 methods=["GET", "POST"] 表示既支持GET方式也支持POST方式的請求。

獲取某個用戶信息接口

@app.route("/users/<int:user_id>", methods=["GET"])
def get_user(user_id):
    """獲取某個用戶信息"""
    if user_id > 0 and user_id <= len(data):
        return jsonify({"code": "0", "data": data[user_id - 1], "msg": "操作成功"})
    return jsonify({"code": "1", "msg": "用戶不存在"})

在這里，我們的請求URL中有變量（因為需要獲取指定的用戶信息），對於變量，我們需要使用 <> ，如 <user_id>，這樣就可以將這些特殊部分標記為變量名。

在上面代碼中，我們使用的是 <int:user_id>，這里用到了Flask自帶的路由轉換器 int，表示接收到的 user_id 是整數類型，如果不加的話，那么就默認是 string 轉換器。

而我們獲取到指定的用戶信息，則是用 data[user_id - 1] 來實現，比如要獲取到data中第2條用戶信息，那么用data[1]就可以得到，另外，如果請求的 user_id 不在當前范圍的，則是直接返回用戶不存在的JSON數據。。

設置返回中文數據正常顯示

完成以上內容后，我們運行代碼，然后到Chrome瀏覽器上進行請求。

這里在Chrome瀏覽器中文顯示為了Unicode字符編碼，雖然不影響接口的讀取，但是可讀性不好啊，於是需要在代碼中做簡單處理，直接加一行代碼即可：

app.config["JSON_AS_ASCII"] = False # jsonify返回的中文正常顯示

最后，再次進行請求，就可以得到想要的數據了。

源碼附上：

from flask import Flask, jsonify

app = Flask(__name__)
app.config["JSON_AS_ASCII"] = False  # jsonify返回的中文正常顯示

data = [
    {"id": 1, "username": "小明", "password": "123456", "role": 0, "sex": 0, "telephone": "10086", "address": "北京市海淀區"},
    {"id": 2, "username": "李華", "password": "abc", "role": 1, "sex": 0, "telephone": "10010", "address": "廣州市天河區"},
    {"id": 3, "username": "大白", "password": "666666", "role": 0, "sex": 1, "telephone": "10000", "address": "深圳市南山區"}
]


@app.route('/')
def hello_world():
    return 'Hello World!'


@app.route("/users", methods=["GET"])
def get_all_users():
    """獲取所有用戶信息"""
    return jsonify({"code": "0", "data": data, "msg": "操作成功"})


@app.route("/users/<int:user_id>", methods=["GET"])
def get_user(user_id):
    """獲取某個用戶信息"""
    if user_id > 0 and user_id <= len(data):
        return jsonify({"code": "0", "data": data[user_id - 1], "msg": "操作成功"})
    return jsonify({"code": "1", "msg": "用戶不存在"})


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