fastapi 从入门到精通

### FastAPI 的入门教程 FastAPI 是一种现代、快速（高性能）、基于 Python 类型提示的 Web 框架。它旨在简化 API 开发过程并提供强大的功能支持，例如自动化的交互文档和内置的数据验证。 #### 初学者的学习路径 对于初学者来说，《FastAPI Web Development》是一本非常优秀的书籍[^1]。书中不仅介绍了 FastAPI 的基本概念，还提供了许多实用的例子来帮助理解其核心特性。以下是几个重要的基础知识： - **安装与配置**: 需要先准备好开发环境，建议使用 Python 3.10 或更高版本，并选择合适的 IDE 如 PyCharm 社区版进行编码[^3]。 - **创建第一个应用**: 下面是一个简单的 Hello World 应用程序示例： ```python from fastapi import FastAPI app = FastAPI() @app.get("/") async def read_root(): return {"message": "Hello World"} ``` 此代码定义了一个 GET 路由 `/` ，当访问该路由时会返回 JSON 格式的 `{"message": "Hello World"}`[^2]。 - **数据模型与请求体**: 使用 Pydantic 来定义数据模型可以轻松实现数据验证。例如，在注册用户的场景下可以通过如下方式定义用户结构并处理 POST 请求[^2]: ```python from fastapi import FastAPI, HTTPException from pydantic import BaseModel app = FastAPI() class User(BaseModel): username: str email: str password: str @app.post("/register/") def register_user(user: User): if user.username == "admin": raise HTTPException(status_code=400, detail="Username 'admin' is not allowed.") return {"username": user.username, "email": user.email} ``` --- ### FastAPI 的高级用法 随着对框架的理解加深，开发者可以探索更多复杂的功能和技术细节。这些技术能够显著提升应用程序的质量和性能。 #### 异步编程的支持 FastAPI 对异步操作有很好的原生支持，这使得它可以高效地管理 I/O 密集型任务而不阻塞主线程。下面是如何编写一个异步视图函数的一个简单例子: ```python from fastapi import FastAPI import asyncio app = FastAPI() @app.get("/async-example/") async def async_example(): await asyncio.sleep(2) # Simulate an asynchronous operation. return {"result": "This was processed asynchronously."} ``` 这里我们模拟了一次耗时的操作 (`await asyncio.sleep`) 并将其标记为异步执行。 #### 中间件(Middleware) 中间件允许你在请求到达路由器之前或者响应发送给客户端之后拦截它们。这对于日志记录、身份认证等功能特别有用。 ```python from starlette.middleware.base import BaseHTTPMiddleware from fastapi import Request class LoggingMiddleware(BaseHTTPMiddleware): async def dispatch(self, request: Request, call_next): response = await call_next(request) print(f"{request.method} {request.url.path}") # Log the method and path of each request. return response ``` 将自定义中间件添加到应用中的方法如下所示： ```python from fastapi import FastAPI app = FastAPI() @app.on_event("startup") def startup_event(): app.add_middleware(LoggingMiddleware) @app.get("/") async def root(): return {"message": "Logged!"} ``` #### 自动化测试 为了确保 API 接口的行为符合预期，应该为其编写单元测试。FastAPI 提供了 TestClient 工具用于方便快捷地完成这项工作。 ```python from fastapi.testclient import TestClient from main import app client = TestClient(app) def test_read_main(): response = client.get("/") assert response.status_code == 200 assert response.json() == {"message": "Hello World"} ``` --- ### 总结 无论是新手还是有一定经验的程序员都可以从学习 FastAPI 中受益匪浅。通过掌握基础概念以及尝试更复杂的特性和模式，你可以构建既强大又灵活的应用程序。