FastAPI 与 Supabase 模板项目启动和配置指南

FastAPI 与 Supabase 模板项目启动和配置指南

fastapi_supabase_template 👏fastapi deeply integrates with supabase，auth，curd postgresql，file upload ，etc ， all in one😎，inspired by full stack fastapi postgresql 项目地址: https://gitcode.com/gh_mirrors/fa/fastapi_supabase_template

1. 项目目录结构及介绍

当您克隆或下载 FastAPI Supabase 模板项目后，会看到以下目录结构：

fastapi_supabase_template/
├── app/
│   ├── __init__.py
│   ├── main.py
│   ├── dependencies.py
│   ├── api/
│   │   ├── __init__.py
│   │   ├── endpoints.py
│   │   └── ...
│   ├── core/
│   │   ├── __init__.py
│   │   ├── config.py
│   │   └── ...
│   ├── db/
│   │   ├── __init__.py
│   │   ├── base_class.py
│   │   └── ...
│   └── models/
│       ├── __init__.py
│       └── ...
├── tests/
│   ├── __init__.py
│   └── test_main.py
├── requirements.txt
└── README.md

以下是各部分的简要说明：

• app/: 项目的主要应用程序目录。

  • __init__.py: 初始化应用程序包。
  • main.py: FastAPI 应用程序的入口点。
  • dependencies.py: 存储依赖关系函数，如数据库会话管理。
  • api/: 包含所有 API 端点的模块。
  • core/: 包含项目的核心功能，如配置和异常处理。
  • db/: 数据库相关代码，如数据库基类和数据库模型。
  • models/: 定义数据库模型的地方。

• tests/: 测试代码目录。

  • __init__.py: 初始化测试包。
  • test_main.py: 包含 FastAPI 应用程序的功能测试。

• requirements.txt: 项目依赖文件，包含运行项目所需的 Python 包。

• README.md: 包含项目信息和说明的 Markdown 文件。

2. 项目的启动文件介绍

项目的主要启动文件是 app/main.py，以下是该文件的简要介绍：

from fastapi import FastAPI
from . import dependencies
from .api import endpoints

app = FastAPI()

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

# 其他路由和端点的注册代码...

在 main.py 中，您将创建一个 FastAPI 应用实例，并定义路由和端点。您还可以看到，我们导入了依赖项和 API 端点模块，以便在应用程序中使用。

3. 项目的配置文件介绍

配置文件位于 app/core/config.py，以下是配置文件的基本结构：

from pydantic import BaseSettings

class Settings(BaseSettings):
    app_name: str = "FastAPI Supabase Template"
    database_url: str

    class Config:
        env_file = ".env"

settings = Settings()

在这个配置文件中，我们定义了一个 Settings 类，它继承自 pydantic.BaseSettings。这允许我们使用环境变量来配置应用程序，并且能够通过 .env 文件来管理这些环境变量。app_name 和 database_url 是示例配置项，您可以根据需要添加更多配置。

在项目的根目录下，您可以创建一个 .env 文件来存储您的环境变量，如下所示：

DATABASE_URL="postgresql://username:password@localhost:5432/mydatabase"

确保更新 .env 文件中的值，以匹配您的实际数据库凭证和环境设置。

fastapi_supabase_template 👏fastapi deeply integrates with supabase，auth，curd postgresql，file upload ，etc ， all in one😎，inspired by full stack fastapi postgresql 项目地址: https://gitcode.com/gh_mirrors/fa/fastapi_supabase_template