有一個非常簡單的需求:編寫一個 HTTP 接口,使用 POST 方式發送一個 JSON 字符串,接口裏面讀取發送上來的參數,對其中某個參數進行處理,並返回。
如果我們使用 Flask 來開發這個接口,那麼代碼是這樣的:
from flask import Flask, request
app = Flask(__name__)
@app.route('/insert', methods=['POST'])
def insert():
info = request.json
name = info['name']
age = info['age']
age_after_10_years = age + 10
msg = f'此人名叫:{name},10年後,此人年齡:{age_after_10_years}'
return {'success': True, 'msg': msg}
代碼看起來已經很簡潔了。我們用requests
發個請求看看效果,如下圖所示:
看起來沒什麼問題。
現在,我搞點破壞,把age
字段改成字符串,再運行一下:
不出所料,報錯了。
現在我們把age
字段改回數字,但是直接移除name
字段:
又報錯了。
爲了防止用戶不按規矩提交數據,我們必須在接口裏面做好各種異常數據的判斷。於是增加判斷以後的代碼變得複雜了:
@app.route('/insert', methods=['POST'])
def insert():
info = request.json
name = info.get('name', '')
ifnot name:
return {'success': False, 'msg': 'name 參數不可省略,不可爲空!'}
age = info.get('age', 0)
ifnot isinstance(age, int):
return {'success': False, 'msg': 'age參數不是數字!'}
age_after_10_years = age + 10
msg = f'此人名叫:{name},10年後,此人年齡:{age_after_10_years}'
return {'success': True, 'msg': msg}
看來,用 Flask,雖然能讓你用很短的代碼寫出一個能工作的項目。但要寫成一個可以正常使用的項目,還是需要你自己寫更多代碼。
下面我們來看一下,現代化的 web 框架:FastApi
能把這個工程簡化到什麼程度:
from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()
class People(BaseModel):
name: str
age: int
address: str
salary: float
@app.post('/insert')
def insert(people: People):
age_after_10_years = people.age + 10
msg = f'此人名字叫做:{people.name},十年後此人年齡:{age_after_10_years}'
return {'success': True, 'msg': msg}
我們還是使用 requests 發一條信息給 FastApi 開發的 HTTP 接口。對於正常數據,正常使用:
現在我們把age
字段改成字符串:
返回友好的提示信息,告訴我類型錯誤:age 字段不是 integer
。
我們再試一試把name
字段去掉:
返回友好信息,提示值錯誤:name字段丟失
。
整個過程中,對類型的檢查全都由 FastApi 自己完成。我們省下來很多時間。
我用了 Flask 四年,但在使用了 5 分鐘 FastApi 以後,我決定以後不再使用 Flask 了。
回過頭來,我們好好介紹一下 FastApi。
使用pip
或者pipenv
即可安裝 FastApi:
pip install fastapi
pipenv install fastapi
安裝完成以後,我們來完成第一個 API:
from fastapi import FastAPI
app = FastAPI()
@app.get('/')
def index():
return {'message': '你已經正確創建 FastApi 服務!'}
這裏的寫法跟 Flask 幾乎一致。只不過在 Flask 中,我們定義路由的裝飾器爲@app.route('/')
。而這裏寫爲@app.get('/')
寫好代碼以後,我們需要使用uvicorn
來運行 FastApi。首先使用pip
或者pipenv
安裝uvicorn
:
pip install uvicorn
pipenv install uvicorn
然後執行命令:
uvicorn main:app --reload
其中main
表示我們的代碼文件爲main.py
,app
表示我們初始化的 FastApi 對象的名字。--reload
參數表示在修改了代碼以後立即生效,不需要重啓。
運行命令以後,我們訪問http://127.0.0.1:8000
可以看到接口已經正確返回了 JSON 格式的數據:
那麼如何定義一個帶參數的 GET 方法呢?我們再寫一段代碼:
@app.get('/query/{uid}')
def query(uid):
msg = f'你查詢的 uid 爲:{uid}'
return {'success': True, 'msg': msg}
寫好代碼以後,我們直接在瀏覽器裏面訪問新的地址,可以看到修改已經生效了,如下圖所示:
如果想限定 uid 只能是數字,不能是字符串怎麼辦呢?你只需要多加 4 個字符
:
@app.get('/query/{uid}')
def query(uid: int):
msg = f'你查詢的 uid 爲:{uid}'
return {'success': True, 'msg': msg}
對函數query
的參數使用類型標註,標註爲 int 類型。現在我們再來訪問一下接口:
當 query 後面的參數不是整數時,正常報錯了。
我們再來看一下本文一開始的 POST 方法。在使用 Flask 的時候,我們需要手動驗證用戶 POST 提交上來的數據是什麼格式的,字段對不對。
但使用 FastApi 的時候,我們只需要類型標註就能解決所有問題。首先我們導入from pydantic import BaseModel
,然後繼承BaseModel
實現我們允許 POST 方法提交上來的數據字段和格式:
from pydantic import BaseModel
app = FastAPI()
class People(BaseModel):
name: str
age: int
address: str
salary: float
People
這個類通過類型標註,指定了它裏面的 4 個字段和他們的類型。現在,我們來實現 POST 方法:
@app.post('/insert')
def insert(people: People):
age_after_10_years = people.age + 10
msg = f'此人名字叫做:{people.name},十年後此人年齡:{age_after_10_years}'
return {'success': True, 'msg': msg}
insert
函數的參數people
通過類型標註指定爲People
類型。
當我們使用 POST 方式提交數據時,FastApi 自動會以People
中定義的字段爲基準來校驗數據,發現不對就返回報錯信息。
除了開發接口變得非常簡單外,FastApi 還會自動幫我們生成接口文檔。大家訪問http://127.0.0.1:8000/docs
,可以看到接口文檔已經自動生成好了:
這個接口不僅能看,而且直接就能在接口頁面修改樣例數據,發送請求,現場測試:
以上是對 FastApi 的極簡介紹。有興趣的同學可以查閱它的官方文檔。
最後,告訴大家,FastApi 是一個異步 Web 框架,它的速度非常非常非常快。遠遠超過 Flask。
FastApi 是最快的幾個 Web 框架之一。速度可以匹敵 Golang 寫的接口。詳細的對比可以看:https://www.techempower.com/benchmarks/#p=test&runid=7464e520-0dc2-473d-bd34-dbdfd7e85911&hw=ph&test=query&l=zijzen-7
618噹噹福利:
衝鴨!羊毛薅起來!噹噹618專享不到4折,Python書籍囤起來!
618來襲,雖然Python的電子書很多,但是經典的Python書籍還是要看紙質的書,感覺這樣纔有踏實感,而且長時間眼睛閱讀也會舒服一些。我推薦幾本非常不錯的Python書單,都是居家旅行必備的書籍。
Python修煉必讀:
Python高級編程
Python Cookbook
流暢的Python
Python基礎教程
精通正則表達式
內功修煉:
代碼大全,重構,CleanCode 這些經典的書籍必須要收藏先!
一起來薅噹噹的羊毛吧
全場自營圖書每滿100減50元 、滿200元減100元
在噹噹APP或者小程序結算時輸入優惠碼
優惠碼 (VZGVZE) 滿150再減30元
花120元買300的書
優惠碼有效期:6.9-6.20
優惠碼數量有限,先到先得哦