PyMongo FastAPI CRUD 项目教程
1. 项目的目录结构及介绍
pymongo-fastapi-crud/
├── app
│ ├── __init__.py
│ ├── main.py
│ ├── models.py
│ ├── routes.py
│ └── schemas.py
├── config
│ └── settings.py
├── requirements.txt
└── README.md
app/
: 包含项目的主要代码文件。__init__.py
: 初始化文件,用于将app
目录作为一个模块。main.py
: 项目的启动文件。models.py
: 定义数据库模型。routes.py
: 定义 API 路由。schemas.py
: 定义数据验证和序列化模式。
config/
: 包含项目的配置文件。settings.py
: 配置文件,包含数据库连接等设置。
requirements.txt
: 项目依赖文件。README.md
: 项目说明文档。
2. 项目的启动文件介绍
app/main.py
是项目的启动文件,主要包含以下内容:
from fastapi import FastAPI
from app.routes import router
app = FastAPI()
app.include_router(router)
@app.get("/")
def read_root():
return {"message": "Welcome to the PyMongo FastAPI CRUD example!"}
- 导入
FastAPI
和router
。 - 创建
FastAPI
实例app
。 - 包含
router
路由。 - 定义根路径的 GET 请求处理函数
read_root
。
3. 项目的配置文件介绍
config/settings.py
是项目的配置文件,主要包含以下内容:
from pydantic import BaseSettings
class Settings(BaseSettings):
mongo_uri: str = "mongodb://localhost:27017"
database_name: str = "test_db"
settings = Settings()
- 定义
Settings
类继承自BaseSettings
。 - 设置
mongo_uri
和database_name
的默认值。 - 创建
Settings
实例settings
。
通过这些配置,项目可以连接到指定的 MongoDB 数据库。