Python FastAPI中文使用手册

FastAPI 是一个现代、快速（高性能）的 Web 框架，用于构建 API，基于 Python 编程语言。它由 Sebastián Ramírez 创造，已经迅速成为一个非常流行的 Python Web 框架，特别适合用于构建 RESTful 和 GraphQL API。 ### 知识点一：FastAPI 基础概念 FastAPI 的设计哲学是简单、易于使用。它具有以下特点： 1. **自动交互式文档**：FastAPI 使用 OpenAPI（以前称为 Swagger）和 ReDoc 创建交互式 API 文档。 2. **数据校验**：基于请求体、路径参数和查询参数，FastAPI 可以自动进行数据校验。 3. **异步支持**：FastAPI 内置异步功能，可以轻松处理高并发场景。 4. **安全性**：FastAPI 支持 OAuth2 和 JWT 令牌。 5. **轻量级**：FastAPI 是轻量级的，没有不必要的抽象层，可以直接使用标准库，如 `asyncio` 和 `httpx`。 ### 知识点二：安装和创建项目 要开始使用 FastAPI，首先需要安装它。可以使用 pip 包管理器： ```bash pip install fastapi uvicorn ``` 安装完成后，可以创建一个简单的 FastAPI 应用： ```python from fastapi import FastAPI app = FastAPI() @app.get("/") async def root(): return {"message": "Hello World"} ``` 使用 `uvicorn` 运行这个应用： ```bash uvicorn main:app --reload ``` ### 知识点三：路由和控制器 在 FastAPI 中，可以使用装饰器来定义路由。FastAPI 支持 HTTP 方法如 `get`, `post`, `put`, `delete` 等。 ```python from fastapi import FastAPI app = FastAPI() @app.get("/items/{item_id}") async def read_item(item_id: int): return {"item_id": item_id} ``` ### 知识点四：请求体和模型 FastAPI 允许定义请求体模型，它会自动将传入的 JSON 数据映射到定义的 Python 类型。还可以使用 Pydantic 库定义数据模型。 ```python from pydantic import BaseModel class Item(BaseModel): name: str description: str | None = None price: float tax: float | None = None @app.post("/items/") async def create_item(item: Item): return item ``` ### 知识点五：路径参数和查询参数 可以为路径和查询参数定义类型，FastAPI 会自动处理类型转换和数据校验。 ```python from fastapi import FastAPI app = FastAPI() @app.get("/items/{item_id}") async def read_item(item_id: int, q: str | None = None): return {"item_id": item_id, "q": q} ``` ### 知识点六：依赖注入 FastAPI 允许创建依赖项，并且可以作为依赖项注入到任何路由函数中。 ```python from fastapi import Depends, FastAPI def some_dependency(): return {"msg": "Hello World"} app = FastAPI() @app.get("/") async def read_main(dependency=Depends(some_dependency)): return dependency ``` ### 知识点七：安全性 FastAPI 提供了对安全性协议如 OAuth2 和 JWT 的内建支持。 ```python from fastapi import FastAPI, Depends, HTTPException, status from fastapi.security import OAuth2PasswordBearer app = FastAPI() oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token") async def get_current_user(token: str = Depends(oauth2_scheme)): # 这里应该有获取用户的逻辑，如果成功则返回用户对象，否则抛出异常 pass @app.get("/users/me") async def read_users_me(current_user=Depends(get_current_user)): return current_user ``` ### 知识点八：错误处理 FastAPI 允许定义自定义的错误处理函数，例如，处理 404 或 401 错误。 ```python from fastapi import FastAPI, HTTPException app = FastAPI() @app.get("/items/{item_id}") async def read_item(item_id: int): if item_id == 3: raise HTTPException(status_code=404, detail="Item not found") return {"item_id": item_id} ``` ### 知识点九：交互式 API 文档 使用 FastAPI 开发的应用都会自带交互式 API 文档，可以访问 `/docs` 或 `/redoc` 来查看。 ### 知识点十：性能优化 为了进一步优化性能，FastAPI 提供了 ASGI 服务器，如 Uvicorn 和 Hypercorn，并且支持多种部署方式，如 Docker 和 Kubernetes。 ### 总结 FastAPI 提供了一系列高级特性，旨在简化 API 的开发和管理。由于其简洁的语法和自动的数据校验和文档生成，它成为数据科学家、机器学习工程师和后端开发者的首选。不仅如此，FastAPI 的异步处理能力使得它非常适合处理大量并发请求，因此在构建微服务架构的应用中也十分受欢迎。