說到web開發框架,小編平常用Flask和Django的比較多,其中的Flask屬於是輕量級的開發框架,寫一個API介面也是十分地方便,不過今天我們要介紹的框架FastAPI同樣在Python開發者當中有著較好地口碑,那麼在開始之前,我們先安裝好需要用到的模組,透過pip指令。
pip install fastapi
而ASGI伺服器可以使用uvicorn,那麼同樣地。
pip install uvicorn
我們先試著用Flask框架來寫一個HelloWorld,程式碼如下:
from flask import Flask, request import json app = Flask(__name__) @app.route('/') def hello_world(): return 'hello world' if __name__ == '__main__': app.run(host='0.0.0.0', port=8889)
小編用的開發工具是Pycharm,我們執行這個腳本會彈出以下的結果。
然後在瀏覽器當中輸入彈出來的url去訪問頁面,如下所示就會出現含有「hello world」的頁面。
從程式碼的邏輯來看,app = Flask(__name__)是建立Flask程式實例,我們在瀏覽器中輸入url傳送請求給web伺服器,然後web伺服器將url轉發給Flask程式實例,因此需要知道對於每個url請求需要啟動哪一部分的程式碼,所以保存了url和Python函數之間的映射關係,處理上述兩者之間關係的是路由,是使用程式實例app.route裝飾器來實作。而執行最後的app.run()就可以啟動服務了,0.0.0.0表示監聽所有位址,指定的連接埠號碼是8889,那麼我們來看一下相對應的FastAPI版本的「HelloWorld」是什麼樣子的,程式碼如下:
from fastapi import FastAPI from fastapi.responses import PlainTextResponse, HTMLResponse, FileResponse import uvicorn app = FastAPI() @app.get("/", response_class=PlainTextResponse) async def hello(): ## async可加可不加,这个随意 return "Hello World!" @app.get("/items/{item_id}") def read_item(item_id: int, q: str = None): return {"item_id": item_id, "q": q} if __name__ == '__main__': uvicorn.run('fast_api_1:app', host='0.0.0.0', port=8000)
我們同樣來運行這段程式碼,FastAPI預設監聽的位址是127.0.0.1,連接埠號碼指定是8000,因此我們輸入http://127.0.0.1:8000/,結果如下所示:
由於傳回的是一個字串,因此我們在response_class處填入的是PlainTextResponse,同時我們也可以在瀏覽器中輸入http://127.0. 0.1:8000/items/5?q=somequery,出來的結果如下圖:
我們在上面的「Hello World 」的基礎之上再來寫幾個案例,例如返回隨機數的操作,在Flask框架當中的程式碼如下:
@app.route('/random-number') def random_number(): return str(random.randrange(100))
我們在瀏覽器中測試一下出來的結果,如下所示:
而在FastAPI框架當中的程式碼也是非常類似的。
@app.get('/random-number', response_class=PlainTextResponse) async def random_number(): return str(random.randrange(100))
接下來我們來看一下,當我們發送一個GET請求,判斷當中的一個url請求參數是否都是由字母組成的,其中Flask框架當中的程式碼如下:
@app.route('/alpha', methods=['GET']) def alpha(): text = request.args.get('text', '') result = {'text': text, 'is_alpha' : text.isalpha()} return jsonify(result)
我們在瀏覽器中測試一下出來的結果,如下所示:
而在FastAPI框架當中相對應的程式碼如下:
@app.get('/alpha') async def alpha(text: str): result = {'text': text, 'is_alpha' : text.isalpha()} return result
上面的幾個案例都是GET請求,下面我們來看POST請求該如何處理,例如我們想透過POST請求來創建一個新用戶,在Flask框架中的程式碼如下:
@app.route('/create-user', methods=['POST']) def create_user(): id = request.form.get('id', '0001') name = request.form.get('name', 'Anonymous') data = {'id': id, 'name': name} result = {'status_code': '0', 'status_message' : 'Success', 'data': data} return jsonify(result)
可以直接在Postman當中測試一下該API的功能,如下所示:
我們需要在「methods」當中指定是用POST請求,而在FastAPI框架當中則不需要指定,直接只用app.post()裝飾器即可:
@app.post('/create-user') async def create_user(id: str = Form(...), name: str = Form(...)): data = {'id': id, 'name': name} result = {'status_code': '0', 'status_message' : 'Success', 'data': data} return result
#而要是碰到需要回傳一個靜態頁面的時候,在Flask框架中的程式碼是這樣子的。
@app.route('/get-webpage', methods=['GET']) def get_webpage(): return render_template('flask_1.html', message="Contact Us")
而在FastAPI框架當中則稍微有些麻煩,程式碼如下:
app.mount("/static", StaticFiles(directory="static"), name="static") ## 用来加载静态页面 templates = Jinja2Templates(directory="templates") @app.get('/get-webpage', response_class=HTMLResponse) async def get_webpage(request: Request): return templates.TemplateResponse("index.html", {"request": request, "message": "Contact Us"})
由於傳回的是靜態頁面,因此response_class相對應的是HTMLResponse
我們將上面所寫的Flask程式碼全部都歸總一下,如下所示:
from flask import Flask, request, render_template import random from flask import jsonify import json app = Flask(__name__) @app.route('/') def hello_world(): return 'hello world' @app.route('/random-number') def random_number(): return str(random.randrange(100)) @app.route('/alpha', methods=['GET']) def alpha(): text = request.args.get('text', '') result = {'text': text, 'is_alpha' : text.isalpha()} return jsonify(result) @app.route('/create-user', methods=['POST']) def create_user(): id = request.form.get('id', '0001') name = request.form.get('name', 'Anonymous') data = {'id': id, 'name': name} result = {'status_code': '0', 'status_message' : 'Success', 'data': data} return jsonify(result) @app.route('/get-webpage', methods=['GET']) def get_webpage(): return render_template('flask_1.html', message="Contact Us") if __name__ == '__main__': app.run(host='0.0.0.0', port=8889)
而将所有的FastAPI框架下的代码全部汇总到一起,则如下所示:
from fastapi import FastAPI, Request, Form import uvicorn from fastapi.staticfiles import StaticFiles from fastapi.responses import PlainTextResponse, HTMLResponse, FileResponse import random from fastapi.templating import Jinja2Templates app = FastAPI() app.mount("/templates", StaticFiles(directory="templates"), name="templates") templates = Jinja2Templates(directory="templates") @app.get("/", response_class=PlainTextResponse) async def hello(): return "Hello World!" @app.get("/items/{item_id}") def read_item(item_id: int, q: str = None): return {"item_id": item_id, "q": q} @app.get('/random-number', response_class=PlainTextResponse) async def random_number(): return str(random.randrange(100)) @app.get('/get-webpage', response_class=HTMLResponse) async def get_webpage(request: Request): return templates.TemplateResponse("index.html", {"request": request, "message": "Contact Us"}) if __name__ == '__main__': uvicorn.run('fast_api_1:app', host='0.0.0.0', port=8000)
以上是手把手教你入門Python中的Web開發框架的詳細內容。更多資訊請關注PHP中文網其他相關文章!