# fastapi

**Repository Path**: zhan_xiaobai/fastapi

## Basic Information

- **Project Name**: fastapi
- **Description**: FastApi脚手架，快速搭建一个fastapi服务
- **Primary Language**: Python
- **License**: MPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 31
- **Forks**: 14
- **Created**: 2024-06-14
- **Last Updated**: 2025-06-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# fastapi

#### 介绍
FastApi脚手架，快速搭建一个fastapi服务

### 开发环境
- python 版本：>= 3.6

### 运行程序

1. 安装依赖

```shell
# python
pip install -r requirements.txt
```
2. 运行程序
```shell
# 开发环境
python main.py
或
python main.py --env dev

# 测试环境
python main.py --env test

# 正式环境
python main.py --env pro
```

### 工程结构解析
```

+---api
|   |   router.py               # 主路由文件
|   |   __init__.py
|   |   
|   +---login                   # 子路由(登录路由)
|   |   |   router.py
|   |   |   __init__.py
|           
+---component                   # 公共组件
|   |   auth.py                 # 路由验证组件
|   |   __init__.py
|           
+---constant                    # 常量文件夹
|   |   codes.py                # 响应码
|   |   const.py                # 常量值
|   |   messages.py             # 响应消息
|   |   status.py               # 响应状态码
|   |   __init__.py
|           
+---core
|   |   custom_exception.py     # 自定义的异常
|   |   middleware.py           # 定义拦截中间件
|   |   server.py               # 应用服务配置(应用初始化等等...)
|   |   __init__.py
|           
+---db                          # 数据库连接
|   |   mysqldb.py              
|   |   redisdb.py
|   |   __init__.py
|           
+---log
|   |   __init__.py             # 日志格式配置
|           
+---logs                        # 日志存放文件夹
|       
+---models                      # 数据模型
|   |   admin.py                # 表模型
|   |   response.py             # 响应模型
|   |   __init__.py
|   |   
|   +---curd                    # 数据增删改查
|   |   |   curd_admin.py       
|   |   |   __init__.py
|   |           
|   +---form                    # 接口入参模型
|   |   |   base.py             # 基础接口入参模型
|   |   |   __init__.py
|           
+---settings                    # 全局参数配置
|   |   develop.py              # 开发环境参数配置文件
|   |   production.py           # 正式环境参数配置文件    
|   |   test.py                 # 测试环境参数配置文件
|   |   __init__.py
|           
+---utils                       # 全局工具包
|   |   tools.py                # 工具函数
|   |   __init__.py
|   
|   main.py                     # 启动文件
|   README.md
|   requirements.txt            # 依赖文件

```

#### 参与贡献
1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request