⚙️ 后端框架
FastAPI
FastAPI Cheat Sheet - 快速参考指南，收录常用语法、命令与实践。
📂 分类 · 后端框架🧭 Markdown 速查🏷️ 2 个标签
#fastapi#python
向下滚动查看内容
Getting Started
Install & Run
BASH
滚动查看更多
pip install fastapi uvicorn
uvicorn main:app --reload
Hello World
PYTHON
滚动查看更多
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
def root():
return {"message": "Hello FastAPI"}
CLI Run Hint
BASH
滚动查看更多
uvicorn main:app --reload
Routing & Parameters
Path Parameter
PYTHON
滚动查看更多
@app.get("/items/{id}")
def read(id: int):
return {"id": id}
Query Parameter
PYTHON
滚动查看更多
@app.get("/search")
def find(q: str = "default"):
return {"q": q}
Optional Query
PYTHON
滚动查看更多
@app.get("/filter")
def filter_data(limit: int = 10, active: bool = True):
return {"limit": limit, "active": active}
Request Body & Validation
Using Pydantic
PYTHON
滚动查看更多
from pydantic import BaseModel
class Item(BaseModel):
name: str
price: float
JSON Body
PYTHON
滚动查看更多
@app.post("/items/")
def create(item: Item):
return item
Response Model
PYTHON
滚动查看更多
@app.post("/items/", response_model=Item)
def create(item: Item):
return item
Forms, Files, Headers
Form Input
PYTHON
滚动查看更多
from fastapi import Form
@app.post("/login")
def login(user: str = Form(...)):
return {"user": user}
File Upload
PYTHON
滚动查看更多
from fastapi import UploadFile, File
@app.post("/upload")
def upload(f: UploadFile = File(...)):
return {"filename": f.filename}
Headers / Cookies
PYTHON
滚动查看更多
from fastapi import Header, Cookie
@app.get("/info")
def info(ua: str = Header(None)):
return {"UA": ua}
Middleware & Dependency
Middleware
PYTHON
滚动查看更多
@app.middleware("http")
async def log_req(req, call_next):
res = await call_next(req)
return res
Dependency
PYTHON
滚动查看更多
from fastapi import Depends
def auth(token: str = ""):
if token != "xyz": raise HTTPException(401)
return True
@app.get("/secure")
def secure(_: bool = Depends(auth)):
return {"secure": True}
Errors & JSON API
HTTP Error
PYTHON
滚动查看更多
from fastapi import HTTPException
@app.get("/err")
def error():
raise HTTPException(404, "Not Found")
JSON API
PYTHON
滚动查看更多
from fastapi import FastAPI
@app.get("/json")
def get_data():
return {"status": "ok"}
Templates & Static
Mount Static
PYTHON
滚动查看更多
from fastapi.staticfiles import StaticFiles
app.mount("/static", StaticFiles(directory="static"), name="static")
Jinja2 Support
PYTHON
滚动查看更多
from fastapi.templating import Jinja2Templates
templates = Jinja2Templates("templates")
Routers & Structure
Routers (Blueprints)
PYTHON
滚动查看更多
from fastapi import APIRouter
router = APIRouter()
@router.get("/")
def admin():
return {"admin": True}
app.include_router(router, prefix="/admin")
Folder Layout
BASH
滚动查看更多
project/
├── main.py
├── static/
├── templates/
├── routers/
│ └── admin.py
└── models/
Docs & Status
Built-in Docs
- Swagger:
/docs - ReDoc:
/redoc
Custom Status Code
PYTHON
滚动查看更多
from fastapi import status
@app.post("/create", status_code=status.HTTP_201_CREATED)
def create():
return {"msg": "Created"}