文章目錄

• • 1. 安裝包
  • 2. 編寫代碼
  • 3. 終端運行
  • 4. 文檔
  • 5. 增加數據

learn from https://fastapi.tiangolo.com/zh/#typer-fastapi

1. 安裝包

# pip install fastapi # pip install uvicorn[standard]

2. 編寫代碼

• main.py

from typing import Optional # typing 模塊用于類型檢查 from fastapi import FastAPIapp = FastAPI()@app.get("/") def read_root():return {'hello': 'world'}@app.get("/items/{item_id}") def read_item(item_id: int, q: Optional[str] = None):return {"item_id": item_id, "q": q}

3. 終端運行

• uvicorn main:app --reload

(pt19) D:\gitcode\Python_learning\fastapi\1> uvicorn main:app --reload INFO: Will watch for changes in these directories: ['D:\\gitcode\\Python_learning\\fastapi\\1'] INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) INFO: Started reloader process [6540] using watchgod INFO: Started server process [32632] INFO: Waiting for application startup. INFO: Application startup complete. uvicorn main:app 命令含義如下:main：main.py 文件（一個 Python "模塊"）。 app：在 main.py 文件中通過 app = FastAPI() 創建的對象。 --reload：讓服務器在更新代碼后重新啟動。僅在開發時使用該選項。

• 在瀏覽器輸入 http://127.0.0.1:8000/items/5?q=somequery
  終端顯示 INFO: 127.0.0.1:4014 - "GET /items/5?q=somequery HTTP/1.1" 200 OK
  瀏覽器顯示 {"item_id":5,"q":"somequery"}

• 瀏覽器輸入 http://127.0.0.1:8000/items/x?q=somequery
  終端顯示

INFO: 127.0.0.1:4014 - "GET /favicon.ico HTTP/1.1" 404 Not Found INFO: 127.0.0.1:4022 - "GET /favicon.ico HTTP/1.1" 404 Not Found INFO: 127.0.0.1:4022 - "GET /favicon.ico HTTP/1.1" 404 Not Found INFO: 127.0.0.1:4015 - "GET /items/x?q=somequery HTTP/1.1" 422 Unprocessable Entity

瀏覽器顯示

{"detail":[{"loc":["path","item_id"],"msg":"value is not a valid integer","type":"type_error.integer"}]}

如果把 main 里面的 : int 刪除，則不檢查參數類型，原來是框架內部做了強制檢查

• 同樣的，輸入 http://127.0.0.1:8000/，返回 {"hello":"world"}
• 輸入 http://127.0.0.1:8000/items/5，返回 {"item_id":5,"q":null}

上面呢，我們創建了具有下面功能的 API

• 通過 路徑 / 和 /items/{item_id} 接受 HTTP 請求。
• 以上 路徑 都接受 GET 操作（也被稱為 HTTP 方法）。
• /items/{item_id} 路徑 有一個 路徑參數 item_id 并且應該為 int 類型。
• /items/{item_id} 路徑 有一個可選的 str 類型的 查詢參數 q

4. 文檔

• 瀏覽器輸入 http://127.0.0.1:8000/docs
  
• 瀏覽器輸入 http://127.0.0.1:8000/redoc
  

5. 增加數據

• 添加 Item 類

# pip install fastapi # pip install uvicorn[standard]from typing import Optional # typing 模塊用于類型檢查 from fastapi import FastAPI from pydantic import BaseModel# pydantic庫是一種常用的用于數據接口schema定義與檢查的庫app = FastAPI()class Item(BaseModel):name: strprice: floatis_offer: Optional[bool] = None@app.get("/") def read_root():return {'hello': 'world'}@app.get("/items/{item_id}") def read_item(item_id: int, q: Optional[str] = None):return {"item_id": item_id, "q": q}@app.put("/items/{item_id}") def update_item(item_id: int, item: Item):return {"item_name": item.name, "item_id": item_id}

總結

以上是生活随笔為你收集整理的fastapi quickstart学习的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。