一蒋纬、 Fastapi是什么
FastAPI 框架尿扯,高性能涮坐,易于學(xué)習(xí),高效編碼淑玫,生產(chǎn)可用
FastAPI 是一個(gè)用于構(gòu)建 API 的現(xiàn)代、快速(高性能)的 web 框架面睛,使用 Python 3.6+ 并基于標(biāo)準(zhǔn)的 Python 類型提示絮蒿。
二、Fastapi特點(diǎn)
快速:可與 NodeJS 和 Go 比肩的極高性能(歸功于 Starlette 和 Pydantic)叁鉴。最快的 Python web 框架之一土涝。
高效編碼:提高功能開發(fā)速度約 200% 至 300%。*
更少 bug:減少約 40% 的人為(開發(fā)者)導(dǎo)致錯(cuò)誤幌墓。*
智能:極佳的編輯器支持但壮。處處皆可自動(dòng)補(bǔ)全,減少調(diào)試時(shí)間常侣。
簡(jiǎn)單:設(shè)計(jì)的易于使用和學(xué)習(xí)蜡饵,閱讀文檔的時(shí)間更短。
簡(jiǎn)短:使代碼重復(fù)最小化胳施。通過(guò)不同的參數(shù)聲明實(shí)現(xiàn)豐富功能溯祸。bug 更少。
健壯:生產(chǎn)可用級(jí)別的代碼舞肆。還有自動(dòng)生成的交互式文檔焦辅。
標(biāo)準(zhǔn)化:基于(并完全兼容)API 的相關(guān)開放標(biāo)準(zhǔn):OpenAPI (以前被稱為 Swagger) 和 JSON Schema。
- 根據(jù)對(duì)某個(gè)構(gòu)建線上應(yīng)用的內(nèi)部開發(fā)團(tuán)隊(duì)所進(jìn)行的測(cè)試估算得出胆绊。
三氨鹏、 使用簡(jiǎn)介
3.1. 依賴
版本 Python 3.6 +
Fastapi 主要依賴一下兩個(gè)庫(kù):
- Starlette 主要負(fù)責(zé)web部分
- Pydantic 負(fù)責(zé)數(shù)據(jù)部分
3.2. 安裝
# [fastapi v0.74.0]
pip install fastapi
# 還需要一個(gè)ASGI [uvicorn v0.17.5]
pip install uvicorn[standart]
3.3. 示例
3.3.1創(chuàng)建 main.py 文件
from fastapi import FastAPI
from typing import Optional
app = FastAPI()
@app.get("/")
def read_root():
return {"data": "hello world"}
@app.get("/items/{item_id}")
def get_item(item_id: int, q: Optional[str] = None):
return {"item_id": item_id, "q": q}
你已經(jīng)創(chuàng)建了一個(gè)具有以下功能的 API:
- 通過(guò) 路徑
/
和/items/{item_id}
接受 HTTP 請(qǐng)求。 - 以上 路徑 都接受
GET
操作(也被稱為 HTTP 方法)压状。 -
/items/{item_id}
路徑 有一個(gè) 路徑參數(shù)item_id
并且應(yīng)該為int
類型仆抵。 -
/items/{item_id}
路徑 有一個(gè)可選的str
類型的 查詢參數(shù)q
跟继。
3.3.2 運(yùn)行 main.py 文件
# main: 程序文件的文件名
# app: 主程序入口函數(shù)
# reload: 讓服務(wù)器在更新代碼后重新啟動(dòng)。僅在開發(fā)時(shí)使用該選項(xiàng)
$ uvicorn main:app --reload
INFO: Will watch for changes in these directories: ['/workspace/fastapitest']
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO: Started reloader process [62315] using statreload
INFO: Started server process [62317]
INFO: Waiting for application startup.
INFO: Application startup complete.
3.3.3 檢查
使用瀏覽器訪問(wèn) http://127.0.0.1:8000/items/7788?q=somestr
# 瀏覽器將會(huì)顯示
{"item_id":7788,"q":"somestr"}
3.3.4 交互API文檔 (原swagger)
現(xiàn)在訪問(wèn) http://127.0.0.1:8000/docs
你會(huì)看到自動(dòng)生成的交互式 API 文檔(由 Swagger UI生成):
3.3.5 可選API文檔 redoc
訪問(wèn) http://127.0.0.1:8000/redoc 镣丑。
你會(huì)看到另一個(gè)自動(dòng)生成的文檔(由 ReDoc 生成):