FastAPI 是一个现代、快速(高性能)的 Web 框架,用于构建 API,由 Python 3.6+ 支持。它具有异步支持,并且可以与任何数据库一起使用。FastAPI 的设计哲学是“快速开发,快速部署”,这使得它成为构建高效API的理想选择。
快速安装FastAPI
在开始之前,确保你的 Python 环境已经安装了 uvicorn,这是一个 ASGI 服务器,用于运行 FastAPI 应用。以下是如何安装 FastAPI 和 uvicorn 的步骤:
pip install fastapi uvicorn
快速创建一个FastAPI应用
创建一个 FastAPI 应用非常简单。以下是一个基本的例子:
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def read_root():
return {"Hello": "World"}
在这个例子中,我们创建了一个简单的 FastAPI 应用,它有一个根路由(/),当访问这个路由时,它会返回一个 JSON 对象。
路由和视图函数
FastAPI 使用 Python 函数作为视图函数。每个视图函数都关联一个或多个路由。以下是一个包含多个路由的例子:
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def read_root():
return {"Hello": "World"}
@app.get("/items/{item_id}")
async def read_item(item_id: int):
return {"item_id": item_id}
在这个例子中,我们添加了一个新的路由 /items/{item_id},它接受一个名为 item_id 的路径参数。
数据模型
FastAPI 使用 Pydantic 库来定义数据模型。Pydantic 允许你定义数据结构,并自动验证传入的数据是否符合这些结构。以下是一个使用 Pydantic 模型的例子:
from pydantic import BaseModel
from fastapi import FastAPI
app = FastAPI()
class Item(BaseModel):
id: int
name: str
description: str = None
price: float
tax: float = None
@app.post("/items/")
async def create_item(item: Item):
return item
在这个例子中,我们定义了一个 Item 模型,并在创建新项目时使用它。
异步支持
FastAPI 是异步的,这意味着它可以同时处理多个请求。以下是一个异步视图函数的例子:
from fastapi import FastAPI
app = FastAPI()
@app.get("/items/{item_id}")
async def read_item(item_id: int):
# 模拟异步操作
await asyncio.sleep(1)
return {"item_id": item_id}
在这个例子中,我们使用 await asyncio.sleep(1) 来模拟一个耗时的异步操作。
中间件
FastAPI 支持中间件,允许你在请求处理过程中添加自定义逻辑。以下是一个中间件的例子:
from fastapi import FastAPI, Request
app = FastAPI()
@app.middleware("http")
async def add_process_time_header(request: Request, call_next):
process_time = await asyncio.sleep(1)
response = await call_next(request)
response.headers["X-Process-Time"] = str(process_time)
return response
在这个例子中,我们添加了一个中间件,它会在每个响应中添加一个 X-Process-Time 标头。
数据库集成
FastAPI 可以与任何数据库一起使用。以下是一个使用 SQLite 数据库的例子:
from fastapi import FastAPI
from pydantic import BaseModel
from typing import List
import sqlite3
app = FastAPI()
class Item(BaseModel):
id: int
name: str
description: str = None
price: float
tax: float = None
@app.get("/items/")
async def read_items():
conn = sqlite3.connect("test.db")
cursor = conn.cursor()
cursor.execute("SELECT * FROM items")
items = cursor.fetchall()
conn.close()
return items
@app.post("/items/")
async def create_item(item: Item):
conn = sqlite3.connect("test.db")
cursor = conn.cursor()
cursor.execute("INSERT INTO items (name, description, price, tax) VALUES (?, ?, ?, ?)",
(item.name, item.description, item.price, item.tax))
conn.commit()
conn.close()
return item
在这个例子中,我们使用 SQLite 数据库来存储和检索项目。
总结
FastAPI 是一个功能强大的工具,可以让你快速构建高效的后端 API。通过使用异步支持、Pydantic 数据模型和中间件,你可以轻松地创建出高性能、可扩展的 API。希望这个指南能帮助你快速上手 FastAPI 后端开发。
