如何快速把你的 Python 代碼變為 API
提到 API 開發,你可能會想到 Django REST Framework,Flask,FastAPI,沒錯,它們完全可以用來編寫 API,不過,今天分享的這個框架可以讓你更快把現有的函數轉化為 API,它就是 Sanic。
Sanic 簡介
Sanic[1],是 Python3.7+ Web 服務器和 Web 框架,旨在提高性能。它允許使用 Python3.5 中添加的 async/await 語法,這可以有效避免阻塞從而達到提升響應速度的目的。Sanic致力于提供一種簡單且快速,集創建和啟動于一體的方法,來實現一個易于修改和拓展的 HTTP 服務,Sanic 具備開箱即用的功能,它可以用于編寫,部署和擴展生產級 Web 應用程序。目前 Github 有 16.3k 的星,有廣泛的社區支持。
有以下特性:
- 內置極速 web server
- 生產準備就緒
- 極高的拓展性
- 支持 ASGI
- 簡單直觀的 API 設計
- 社區保障
- 如何將現有代碼快速轉化為 API
現在讓我們看,如何將代碼轉為 API,假如有已經在 functions.py 寫好的兩個函數:
import datetime
def get_datetime():
return datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
def sum_x_y(x, y):
return x + y
轉化為 API 只需再編寫一個 sanic_app.py :
from sanic import Sanic, json
from functions import get_datetime, sum_x_y
app = Sanic("CodeToAPI")
HOST = "localhost"
PORT = 8000
@app.route("/getdatetime")
async def getdatetime(request):
return json({"now": get_datetime()})
@app.get('/sumxy')
async def sumxy(request):
parameters = request.args
result = sum_x_y(int(parameters['x'][0]), int(parameters['y'][0]))
return json({'result': result})
if __name__ == "__main__":
app.run(host=HOST, port=PORT, debug=False)
然后,只需要執行 python sanic_app.py 就可以啟動 API 服務:
從運行結果可以得知,sanic 已經運行在生產環境模式,這與其他 Web 框架不同,其他框架帶有一個內置的開發服務器,并明確表示它只用于開發。而 Sanic 的情況恰好相反,內置的服務器可以直接用于生產環境。
可以用 curl 進行接口測試:
? curl "http://localhost:8000/getdatetime"
{"now":"2022-07-25 06:34:25"}% ? curl "http://localhost:8000/sumxy?x=12&y=34"
{"result":46}%
如果用 post,且使用 json 傳參,也是簡單的:
@app.post('/sumxy')
async def sumxy(request):
parameters = request.json
print(parameters)
result = sum_x_y(int(parameters['x']), int(parameters['y']))
return json({'result': result})
curl 這樣測試:
? curl -X 'POST' 'http://localhost:8000/sumxy' -H "Content-Type: application/json" -d '{"x":10,"y":20}'
{"result":30}%
部署在其他
Sanic 除了自帶的服務器(大多數情況推薦自帶的服務器用于生產),同樣兼容 ASGI。這意味著您可以使用你喜歡的 ASGI 服務器來運行 Sanic。現在有三大主流的 ASGI 服務器, Daphne、Uvicorn (FastAPI 用的就是這個)、Hypercorn。
也可以部署在 Gunicorn:
gunicorn myapp:app --bind 0.0.0.0:1337 --worker-class sanic.worker.GunicornWorker
靜態文件的處理,及記錄請求訪問日志,又想獲得更好的性能,可以考慮使用 Nginx 作為代理,讓 Nginx 來處理訪問日志和靜態文件,這種方式要比用 Python 處理快得多得多。