### Python FastAPI 后端开发教程与项目结构 #### 1. 项目初始化与基础配置 FastAPI 是一种现代、快速（高性能）的 Web 框架，用于构建 API 的后端服务。其设计遵循声明式风格，支持异步操作并提供自动交互式文档生成功能。 创建一个典型的 FastAPI 项目时，通常会有一个 `main.py` 文件作为入口点[^2]。以下是该项目的核心部分： ```python from fastapi import FastAPI from app.api.endpoints import example app = FastAPI() # 包含路由模块 app.include_router(example.router) @app.get("/") def read_root(): return {"message": "Hello World"} ``` 上述代码展示了如何导入 FastAPI 类以及定义简单的根路径 `/` 处理逻辑。通过调用 `include_router()` 方法，可以将其他模块中的路由注册到主应用程序中。 --- #### 2. 路由管理 为了保持良好的可维护性和扩展性，建议将不同的业务逻辑拆分至独立的模块中。例如，在 `app/api/endpoints/example.py` 中定义具体的 API 接口： ```python from fastapi import APIRouter router = APIRouter() @router.get("/example") def get_example(): return {"data": "This is an example endpoint."} ``` 此模块负责处理特定的功能需求，并将其导出以便在主程序中加载。 --- #### 3. 配置文件说明 对于复杂的生产环境部署而言，合理的配置管理至关重要。可以通过 `.env` 文件存储敏感信息或动态参数，并利用第三方库如 Pydantic 来读取这些变量[^3]。 示例 `.env` 文件内容如下： ``` DB_HOST=localhost DB_PORT=5432 SECRET_KEY=mysecretkey ALGORITHM=HS256 ACCESS_TOKEN_EXPIRE_MINUTES=30 ``` 接着编写对应的解析脚本位于 `config/settings.py` 下面： ```python from pydantic import BaseSettings class Settings(BaseSettings): db_host: str db_port: int secret_key: str algorithm: str access_token_expire_minutes: int settings = Settings(_env_file=".env", _env_file_encoding="utf-8") ``` 这样做的好处是可以轻松切换不同运行模式下的设定而无需修改源码本身。 --- #### 4. 用户认证机制 当涉及到安全性较高的场景时，则需要引入身份验证流程来保护资源访问权限。下面给出了一种基于 Cookies 实现登录状态维持的方式[^4]： ```python from fastapi import Depends, HTTPException, status, Response, Cookie from datetime import timedelta async def authenticate_user(username: str, password: str): """模拟用户校验过程""" if username == "test" and password == "password": return True raise HTTPException( status_code=status.HTTP_401_UNAUTHORIZED, detail="Incorrect username or password", ) @app.post("/login") async def login(response: Response, username: str, password: str): authenticated = await authenticate_user(username=username, password=password) if not authenticated: raise HTTPException(status_code=400, detail="Login failed") token_expires_in_seconds = settings.access_token_expire_minutes * 60 response.set_cookie(key="auth_token", value="your_generated_jwt_here", httponly=True, max_age=token_expires_in_seconds) return {"detail": "Logged in successfully"} @app.get("/protected-route") async def protected_route(auth_token: str | None = Cookie(default=None)): if auth_token != "your_expected_value": raise HTTPException(status_code=403, detail="Not authorized") return {"message": "You are authorized to see this content!"} ``` 这里演示了如何设置和获取客户端发送过来的 cookie 数据，同时结合 JWT (JSON Web Token) 技术完成更安全的身份确认工作流。 --- #### 总结 以上就是关于使用 Python 和 FastAPI 构建后端系统的几个重要方面概述。从最基础的应用搭建到最后的安全防护措施都有所涉及。希望对你有所帮助！