1.FastAPI介紹


fastapi.png

一蒋纬、 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)

  • 快速:可與 NodeJSGo 比肩的極高性能(歸功于 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:

  1. 通過(guò) 路徑 //items/{item_id} 接受 HTTP 請(qǐng)求。
  2. 以上 路徑 都接受 GET 操作(也被稱為 HTTP 方法)压状。
  3. /items/{item_id} 路徑 有一個(gè) 路徑參數(shù) item_id 并且應(yīng)該為 int 類型仆抵。
  4. /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生成):

docs.png

3.3.5 可選API文檔 redoc

訪問(wèn) http://127.0.0.1:8000/redoc 镣丑。

你會(huì)看到另一個(gè)自動(dòng)生成的文檔(由 ReDoc 生成):

redoc.png
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末舔糖,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子莺匠,更是在濱河造成了極大的恐慌金吗,老刑警劉巖,帶你破解...
    沈念sama閱讀 216,744評(píng)論 6 502
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件趣竣,死亡現(xiàn)場(chǎng)離奇詭異摇庙,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)遥缕,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,505評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門卫袒,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人单匣,你說(shuō)我怎么就攤上這事夕凝。” “怎么了户秤?”我有些...
    開封第一講書人閱讀 163,105評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵码秉,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我鸡号,道長(zhǎng)转砖,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,242評(píng)論 1 292
  • 正文 為了忘掉前任膜蠢,我火速辦了婚禮堪藐,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘挑围。我一直安慰自己礁竞,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,269評(píng)論 6 389
  • 文/花漫 我一把揭開白布杉辙。 她就那樣靜靜地躺著模捂,像睡著了一般。 火紅的嫁衣襯著肌膚如雪蜘矢。 梳的紋絲不亂的頭發(fā)上狂男,一...
    開封第一講書人閱讀 51,215評(píng)論 1 299
  • 那天,我揣著相機(jī)與錄音品腹,去河邊找鬼岖食。 笑死,一個(gè)胖子當(dāng)著我的面吹牛舞吭,可吹牛的內(nèi)容都是我干的泡垃。 我是一名探鬼主播析珊,決...
    沈念sama閱讀 40,096評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼蔑穴!你這毒婦竟也來(lái)了忠寻?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 38,939評(píng)論 0 274
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤存和,失蹤者是張志新(化名)和其女友劉穎奕剃,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體捐腿,經(jīng)...
    沈念sama閱讀 45,354評(píng)論 1 311
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡纵朋,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,573評(píng)論 2 333
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了叙量。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片倡蝙。...
    茶點(diǎn)故事閱讀 39,745評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡九串,死狀恐怖绞佩,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情猪钮,我是刑警寧澤品山,帶...
    沈念sama閱讀 35,448評(píng)論 5 344
  • 正文 年R本政府宣布,位于F島的核電站烤低,受9級(jí)特大地震影響肘交,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜扑馁,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,048評(píng)論 3 327
  • 文/蒙蒙 一涯呻、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧腻要,春花似錦复罐、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,683評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至趟济,卻和暖如春乱投,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背顷编。 一陣腳步聲響...
    開封第一講書人閱讀 32,838評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工戚炫, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人媳纬。 一個(gè)月前我還...
    沈念sama閱讀 47,776評(píng)論 2 369
  • 正文 我出身青樓双肤,卻偏偏與公主長(zhǎng)得像叛甫,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子杨伙,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,652評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容