FastAPI-Cookbook 项目启动与配置教程

FastAPI-Cookbook 项目启动与配置教程

1. 项目的目录结构及介绍

FastAPI-Cookbook 项目的目录结构如下：

FastAPI-Cookbook/
├── Chapter01/
│   ├── ...
│   └── ...
├── Chapter02/
│   ├── ...
│   └── ...
├── Chapter03/task_manager_app/
│   ├── ...
│   └── ...
├── Chapter04/saas_app/
│   ├── ...
│   └── ...
├── Chapter05/protoapp/
│   ├── ...
│   └── ...
├── Chapter06/ticketing_system/
│   ├── ...
│   └── ...
├── Chapter07/streaming_platform/
│   ├── ...
│   └── ...
├── Chapter08/trip_platform/
│   ├── ...
│   └── ...
├── Chapter09/chat_platform/
│   ├── ...
│   └── ...
├── Chapter10/
│   ├── ...
│   └── ...
├── Chapter11/middleware_project/
│   ├── ...
│   └── ...
├── Chapter12/
│   ├── ...
│   └── ...
├── .gitignore
├── LICENSE
├── README.md

每个 ChapterXX/ 目录代表书中的一个章节，包含了该章节的示例代码和项目。例如，Chapter03/task_manager_app/ 目录包含了第三章中任务管理应用的代码。

• .gitignore：指定 Git 忽略的文件和目录。
• LICENSE：项目的许可证文件，本项目采用 MIT 许可。
• README.md：项目的说明文件，包含了项目的基本信息和如何使用。

2. 项目的启动文件介绍

FastAPI-Cookbook 项目没有单一的启动文件，因为每个章节的示例代码都是独立的项目。通常情况下，每个示例项目的启动文件为一个 main.py 文件，位于相应章节的目录中。以下是一个典型的启动文件结构：

# main.py
from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def read_root():
    return {"Hello": "World"}

要运行这些示例，你需要进入相应章节的目录，并使用以下命令：

uvicorn main:app --reload

这会启动一个开发服务器，你可以通过浏览器访问 http://127.0.0.1:8000/ 来查看结果。

3. 项目的配置文件介绍

FastAPI-Cookbook 项目中的配置通常是直接硬编码在 Python 代码中的。但在真实世界的项目中，推荐使用配置文件来管理配置信息。配置文件可以是 .env 文件、JSON 文件、YAML 文件等。

以下是一个简单的 .env 配置文件示例：

# .env
DATABASE_URL="postgresql://user:password@localhost/dbname"
SECRET_KEY="your_secret_key"

在 Python 代码中，你可以使用 python-dotenv 库来加载这些配置：

from dotenv import load_dotenv
from fastapi import FastAPI

load_dotenv()

app = FastAPI()

@app.get("/")
async def read_root():
    db_url = os.getenv("DATABASE_URL")
    secret_key = os.getenv("SECRET_KEY")
    return {"db_url": db_url, "secret_key": secret_key}

这样，你就可以在代码中安全地使用这些配置信息，而不必硬编码它们。