API Example 项目教程

API Example 项目教程

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

api-example/
├── app/
│   ├── __init__.py
│   ├── api/
│   │   ├── __init__.py
│   │   ├── endpoints/
│   │   │   ├── __init__.py
│   │   │   ├── example.py
│   │   ├── models/
│   │   │   ├── __init__.py
│   │   │   ├── example_model.py
│   ├── core/
│   │   ├── __init__.py
│   │   ├── config.py
│   ├── db/
│   │   ├── __init__.py
│   │   ├── database.py
├── tests/
│   ├── __init__.py
│   ├── test_example.py
├── .env
├── .gitignore
├── README.md
├── requirements.txt
├── run.py

目录结构介绍

• app/: 应用程序的主要代码目录。
  • api/: 包含API的端点和模型。
    • endpoints/: API的端点实现。
    • models/: 数据库模型定义。
  • core/: 核心配置和初始化代码。
  • db/: 数据库相关的代码。
• tests/: 测试代码目录。
• .env: 环境变量配置文件。
• .gitignore: Git忽略文件配置。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖包列表。
• run.py: 项目启动文件。

2. 项目的启动文件介绍

run.py

run.py 是项目的启动文件，负责启动整个应用程序。以下是 run.py 的代码示例：

from app.core.config import settings
from app.db.database import init_db
from app.api.endpoints.example import router as example_router
from fastapi import FastAPI

app = FastAPI()

@app.on_event("startup")
async def startup_event():
    await init_db()

app.include_router(example_router, prefix="/api")

if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="0.0.0.0", port=8000)

启动文件介绍

• FastAPI实例化: app = FastAPI() 创建了一个FastAPI实例。
• 启动事件: @app.on_event("startup") 定义了应用程序启动时执行的初始化操作，例如数据库初始化。
• 路由注册: app.include_router(example_router, prefix="/api") 将API路由注册到应用程序中。
• 运行应用程序: uvicorn.run(app, host="0.0.0.0", port=8000) 使用Uvicorn运行FastAPI应用程序。

3. 项目的配置文件介绍

.env

.env 文件用于存储环境变量，例如数据库连接字符串、密钥等。以下是一个示例：

DATABASE_URL=sqlite:///./test.db
SECRET_KEY=your_secret_key

config.py

config.py 文件位于 app/core/ 目录下，负责加载和解析环境变量，并提供配置对象。以下是 config.py 的代码示例：

from pydantic import BaseSettings

class Settings(BaseSettings):
    database_url: str
    secret_key: str

    class Config:
        env_file = ".env"

settings = Settings()

配置文件介绍

• 环境变量加载: BaseSettings 类从 .env 文件中加载环境变量。
• 配置对象: settings = Settings() 创建了一个配置对象，可以在应用程序中使用。

通过以上介绍，您应该能够理解 api-example 项目的目录结构、启动文件和配置文件的基本内容和作用。