之前的文章已經介紹了如何安裝,以及簡單的使用,這篇文章呢,我們就不去分享如何安裝對應的包了。
我們如何去編寫呢,其實很簡單,按照下面的步驟,一個簡單的基於fastapi的接口就編寫完畢。
首先:創建一個main.py
第一步:導入
from fastapi import FastAPI
第二步:實例化
app = FastAPI()
第三步:定義一個路徑操作裝飾器
@app.get("/") ''' @app.get("/") 告訴 FastAPI 在它下方的函數負責處理如下訪問請求: 請求路徑為 / 使用 get 操作 你也可以使用其他的操作: @app.post() @app.put() @app.delete() 以及更少見的: @app.options() @app.head() @app.patch() @app.trace() 這些對應都是請求方式 '''
第 四步:定義路徑操作函數
第五步:返回內容
#函數在路徑裝飾器的下方 #寫法一 @app.get("/") async def root(): #第五步定義的返回內容 return {"message": "Hello World"} #寫法二 @app.get("/") def root(): #第五步定義的返回內容 return {"message": "Hello World"}
返回內容可以是dict,也可以是list, str、int 等都可以。
然后我們就可以去啟動了。
uvicorn main:app --reload #下面是啟動完畢
我們在瀏覽器去訪問
結果返回正常。
這里要說明的,上面app以及包括main.py還有方法的名稱,大家都可以自己自定義,自定義后啟動,就按照命令改成自己可以用的即可。
上面是一個簡單的get請求,其他請求方式也是可以的,比如我們寫一個post的路徑,我們這里先不交驗參數
定義一個/create路徑,返回post。請求方式是post,如何實現呢?
答案如下:
@app.post("/create")def post(): return "post"
那么我們保存,我們可以看到,后台服務自動重啟了
那么我們用瀏覽器去訪問下
接口直接給我們返回了,方法不被允許,那么我們可以用postman來試下。
這次我們使用post直接返回了,我們定義的post的字符串。這次就大概的給大家演示一個如何創建接口,按照六步法(其中四五可以認為是一步)創建即可。
導入 FastAPI。 創建一個 app 實例。 編寫一個路徑操作裝飾器(如 @app.get("/"))。 編寫一個路徑操作函數(如上面的 def root(): ...) 定義返回值 運行開發服務器(如 uvicorn main:app --reload)