FastAPI 是一个现代、快速(高性能)的 Web 框架,用于构建 API,由 Python 3.6+ 的类型提示功能驱动。它旨在快速开发,同时确保 API 的可维护性和可扩展性。本文将带您从入门到精通,了解 FastAPI 框架的实战技巧。
快速入门
安装 FastAPI 和依赖
首先,确保您的环境中安装了 Python 3.6 或更高版本。然后,使用以下命令安装 FastAPI:
pip install fastapi uvicorn
创建基本项目
创建一个新的目录,并在其中创建一个名为 main.py 的文件。以下是创建一个基本 FastAPI 应用程序的基本代码:
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def root():
return {"message": "Hello World"}
运行应用程序
使用以下命令运行应用程序:
uvicorn main:app --reload
现在,访问 http://127.0.0.1:8000/,您应该会看到 “Hello World” 消息。
高级技巧
路由和视图
FastAPI 使用 Python 函数作为路由和视图。以下是一个使用路径参数的示例:
from fastapi import FastAPI, Path
app = FastAPI()
@app.get("/items/{item_id}")
async def read_item(item_id: int = Path(...)):
return {"item_id": item_id}
类型提示和 Pydantic
FastAPI 利用 Python 3.6 的类型提示功能,结合 Pydantic 库来验证和解析传入的数据。以下是一个使用 Pydantic 模型的示例:
from pydantic import BaseModel
class Item(BaseModel):
id: int
name: str
@app.post("/items/")
async def create_item(item: Item):
return item
数据库集成
FastAPI 支持多种数据库集成,例如 SQLite、PostgreSQL 和 MongoDB。以下是一个使用 SQLAlchemy 集成 SQLite 的示例:
from fastapi import FastAPI
from sqlalchemy.orm import Session
from .database import SessionLocal, engine
from . import models
app = FastAPI()
models.Base.metadata.create_all(bind=engine)
def get_db():
db = SessionLocal()
try:
yield db
finally:
db.close()
@app.get("/items/")
def read_items(db: Session = Depends(get_db)):
return db.query(models.Item).all()
安全性
FastAPI 支持多种安全机制,例如 OAuth2、JWT 和密码哈希。以下是一个使用 OAuth2 的示例:
from fastapi import FastAPI, Depends, HTTPException, status
from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm
app = FastAPI()
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")
@app.post("/token")
async def login_for_access_token(form_data: OAuth2PasswordRequestForm = Depends()):
user = authenticate_user(username=form_data.username, password=form_data.password)
if not user:
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Incorrect username or password",
headers={"WWW-Authenticate": "Bearer"},
)
access_token = create_access_token(data={"sub": user.username})
return {"access_token": access_token, "token_type": "bearer"}
async def authenticate_user(username: str, password: str):
# 这里应该有一个用户验证过程
return User(username=username, password hashed=hash_password(password))
async def get_current_user(token: str = Depends(oauth2_scheme)):
credentials_exception = HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Could not validate credentials",
headers={"WWW-Authenticate": "Bearer"},
)
user = authenticate_token(token, credentials_exception)
if not user:
raise credentials_exception
return user
@app.get("/users/me")
async def read_users_me(current_user: User = Depends(get_current_user)):
return current_user
实战项目
创建一个博客平台
以下是一个使用 FastAPI 创建博客平台的简单示例:
- 安装必要的依赖:
pip install fastapi uvicorn sqlalchemy alembic
- 创建数据库和迁移文件:
alembic init db
- 创建模型和迁移脚本:
# models.py
from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
class BlogPost(Base):
__tablename__ = "blog_posts"
id = Column(Integer, primary_key=True, index=True)
title = Column(String, index=True)
content = Column(String, index=True)
- 创建迁移脚本并应用迁移:
alembic revision -m "create blog posts"
alembic upgrade head
- 创建 FastAPI 应用程序:
# main.py
from fastapi import FastAPI
from sqlalchemy.orm import Session
from . import models
app = FastAPI()
@app.post("/posts/")
def create_post(title: str, content: str, db: Session = Depends(SessionLocal())):
db_post = models.BlogPost(title=title, content=content)
db.add(db_post)
db.commit()
db.refresh(db_post)
return db_post
- 运行应用程序:
uvicorn main:app --reload
现在,您可以使用 FastAPI 创建、读取、更新和删除博客帖子。
总结
FastAPI 是一个功能强大的 Web 框架,可以帮助您快速构建高性能的 API。通过本文的学习,您应该已经掌握了 FastAPI 的基本概念和实战技巧。希望这些知识能够帮助您在未来的项目中取得成功!
