FastAPI MVC 项目使用教程
1. 项目的目录结构及介绍
FastAPI MVC 项目生成的目录结构如下:
my-project/
├── app/
│ ├── __init__.py
│ ├── controllers/
│ ├── models/
│ ├── services/
│ ├── templates/
│ ├── views/
│ └── main.py
├── config/
│ ├── __init__.py
│ ├── settings.py
│ └── config.yaml
├── tests/
│ ├── __init__.py
│ └── test_main.py
├── .gitignore
├── Dockerfile
├── LICENSE
├── README.md
├── docker-compose.yml
├── install_env.sh
├── requirements.txt
└── Makefile
目录结构介绍
app/
: 包含应用程序的主要代码。controllers/
: 控制器模块,处理请求和响应。models/
: 模型模块,定义数据模型。services/
: 服务模块,包含业务逻辑。templates/
: 模板文件,用于渲染视图。views/
: 视图模块,处理前端逻辑。main.py
: 应用程序的入口文件。
config/
: 配置文件目录。settings.py
: 应用程序的配置设置。config.yaml
: 配置文件,用于存储配置信息。
tests/
: 测试文件目录。test_main.py
: 主测试文件。
.gitignore
: Git 忽略文件。Dockerfile
: Docker 配置文件。LICENSE
: 项目许可证。README.md
: 项目说明文档。docker-compose.yml
: Docker Compose 配置文件。install_env.sh
: 环境安装脚本。requirements.txt
: 项目依赖文件。Makefile
: 项目构建文件。
2. 项目的启动文件介绍
项目的启动文件是 app/main.py
,该文件包含了 FastAPI 应用程序的实例化和配置。
from fastapi import FastAPI
from app.controllers import router
app = FastAPI()
app.include_router(router)
if __name__ == "__main__":
import uvicorn
uvicorn.run(app, host="0.0.0.0", port=8000)
启动文件介绍
FastAPI()
:创建 FastAPI 应用程序实例。app.include_router(router)
:包含控制器路由。uvicorn.run(app, host="0.0.0.0", port=8000)
:使用 Uvicorn 运行应用程序。
3. 项目的配置文件介绍
项目的配置文件位于 config/
目录下,主要包括 settings.py
和 config.yaml
。
settings.py
import os
from dotenv import load_dotenv
load_dotenv()
class Settings:
DEBUG = os.getenv("DEBUG", False)
DATABASE_URL = os.getenv("DATABASE_URL", "sqlite:///./sql_app.db")
SECRET_KEY = os.getenv("SECRET_KEY", "secret")
settings = Settings()
config.yaml
debug: true
database_url: "sqlite:///./sql_app.db"
secret_key: "secret"
配置文件介绍
settings.py
:使用环境变量加载配置,并定义了调试模式、数据库 URL 和密钥等配置项。config.yaml
:YAML 格式的配置文件,用于存储配置信息。
以上是 FastAPI MVC 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用该项目。