# first-imooc-fastapi

**Repository Path**: lvzhenchao/first-imooc-fastapi

## Basic Information

- **Project Name**: first-imooc-fastapi
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-20
- **Last Updated**: 2025-05-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# first-imooc-fastapi

#### 介绍
{**以下 是基于fastapi构建的一个框架**}

#### 1、软件架构
软件架构说明

```
FastAPI 推荐目录结构（中大型项目）
.
├── app/
│   ├── main.py               # 启动入口
│   ├── api/                  # 路由模块
│   │   ├── __init__.py
│   │   ├── v1/
│   │   │   ├── __init__.py
│   │   │   ├── users.py
│   │   │   └── items.py
│   ├── core/                 # 配置、初始化
│   │   ├── __init__.py
│   │   ├── config.py         # 配置文件
│   │   └── security.py       # 安全逻辑
│   ├── models/               # Pydantic 数据模型
│   │   ├── __init__.py
│   │   └── user.py
│   ├── db/                   # 数据库逻辑
│   │   ├── __init__.py
│   │   └── database.py       # 连接数据库
│   └── services/             # 业务逻辑
│       ├── __init__.py
│       └── user_service.py
└── requirements.txt

```

#### 2、框架小结

|                  方面                  |推荐做法|
|:---------------------------------------:|:---:|
| 路由   | 使用 `APIRouter` 拆分每个模块               |
| 启动   | `main.py` 仅负责 `FastAPI()` 初始化和挂载模块  |
| 配置   | 使用 `core/config.py` 存储配置，可结合 `.env` |
| 模型   | 使用 `models/` 组织请求/响应结构体             |
| 数据库  | 封装在 `db/`，独立管理连接逻辑                  |
| 服务逻辑 | 单独放 `services/`，避免路由里业务太多           |



#### 访问接口
- 打开浏览器访问 http://127.0.0.1:8000/
- 访问文档：自动生成文档（Swagger UI）：http://127.0.0.1:8000/docs
- 访问文档：ReDoc 文档：http://127.0.0.1:8000/redoc
- pip install -r requirements.txt