FastAPI Cookiecutter 项目教程

FastAPI Cookiecutter 项目教程

cookiecutter-fastapiCookiecutter template for FastAPI projects using: Machine Learning, Poetry, Github Actions and Pytests项目地址:https://gitcode.com/gh_mirrors/co/cookiecutter-fastapi

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

FastAPI Cookiecutter 项目生成的目录结构如下：

reddit_clone/
├── .github/
│   └── workflows/
│       └── ci.yml
├── docs/
│   └── example/
│       └── example.md
├── reddit_clone/
│   ├── __init__.py
│   ├── main.py
│   ├── config.py
│   ├── models/
│   │   └── __init__.py
│   ├── routes/
│   │   └── __init__.py
│   └── services/
│       └── __init__.py
├── tests/
│   └── __init__.py
├── .gitignore
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── cookiecutter.json
└── setup.py

目录结构介绍

• .github/workflows/: GitHub Actions 的工作流配置文件。
• docs/: 项目文档目录。
• reddit_clone/: 项目的主代码目录。
  • main.py: 项目的启动文件。
  • config.py: 项目的配置文件。
  • models/: 存放数据模型的目录。
  • routes/: 存放路由定义的目录。
  • services/: 存放业务逻辑的目录。
• tests/: 存放测试代码的目录。
• .gitignore: Git 忽略文件配置。
• CODE_OF_CONDUCT.md: 行为准则文件。
• CONTRIBUTING.md: 贡献指南文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• cookiecutter.json: Cookiecutter 模板配置文件。
• setup.py: 项目安装配置文件。

2. 项目的启动文件介绍

项目的启动文件是 reddit_clone/main.py。这个文件包含了 FastAPI 应用的实例化和基本配置。

from fastapi import FastAPI
from .config import settings
from .routes import router

app = FastAPI()

app.include_router(router)

@app.get("/")
def read_root():
    return {"message": "Welcome to Reddit Clone!"}

启动文件介绍

• FastAPI 实例化：创建一个 FastAPI 应用实例。
• 路由包含：通过 app.include_router(router) 将路由定义包含到应用中。
• 根路由定义：定义了一个简单的根路由，返回欢迎消息。

3. 项目的配置文件介绍

项目的配置文件是 reddit_clone/config.py。这个文件使用了 Pydantic 的 BaseSettings 类来管理配置。

from pydantic import BaseSettings

class Settings(BaseSettings):
    database_url: str = "sqlite:///./reddit_clone.db"
    secret_key: str = "your_secret_key"
    algorithm: str = "HS256"
    access_token_expire_minutes: int = 30

settings = Settings()

配置文件介绍

• BaseSettings 类：Pydantic 提供的用于环境变量和配置管理的基类。
• 配置项：定义了数据库 URL、密钥、算法和访问令牌过期时间等配置项。
• 实例化：创建一个 Settings 实例，用于在应用中访问配置。

以上是 FastAPI Cookiecutter 项目的目录结构、启动文件和配置文件的详细介绍。希望这些内容能帮助你更好地理解和使用该项目。

cookiecutter-fastapiCookiecutter template for FastAPI projects using: Machine Learning, Poetry, Github Actions and Pytests项目地址:https://gitcode.com/gh_mirrors/co/cookiecutter-fastapi