# fastapi-starter

**Repository Path**: Tender-Liu/fastapi-starter

## Basic Information

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

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-07-01
- **Last Updated**: 2025-08-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# FastAPI Starter 项目

这是一个基于 FastAPI 框架的简单 RESTful API 项目，所有 API 路径都以 `/api` 开头。

## 项目特点

- 使用 FastAPI 框架，提供高性能的 API 服务
- 所有 API 路径都以 `/api` 开头
- 自动生成 OpenAPI 文档
- 使用 Pydantic 模型进行数据验证
- 模块化的项目结构
- 环境变量配置

## 项目结构

```
fastapi-starter/
├── app/                    # 应用程序包
│   ├── __init__.py         # 初始化文件
│   ├── models.py           # 数据模型定义
│   └── routers/            # API 路由模块
│       ├── __init__.py     # 初始化文件
│       ├── items.py        # 商品相关 API
│       ├── system.py       # 系统相关 API
│       └── users.py        # 用户相关 API
├── .env                    # 环境变量配置
├── main.py                 # 应用程序入口
├── README.md               # 项目说明文档
└── requirements.txt        # 项目依赖
```

## 安装与运行

### 前提条件

- Python 3.7+
- pip (Python 包管理器)

### 安装步骤

1. 克隆或下载项目到本地

2. 创建并激活虚拟环境（可选但推荐）

   ```bash
   # 创建虚拟环境
   python -m venv venv
   
   # 激活虚拟环境 (Windows)
   venv\Scripts\activate
   
   # 激活虚拟环境 (Linux/macOS)
   source venv/bin/activate
   ```

3. 安装项目依赖

   ```bash
   pip install -r requirements.txt
   ```

4. 运行应用程序

   ```bash
   python main.py
   ```

   或者使用 uvicorn 直接运行

   ```bash
   uvicorn main:app --reload
   ```

5. 访问 API 文档

   打开浏览器访问 http://localhost:8070/api/docs

## API 端点

### 商品 API

- `GET /api/items` - 获取所有商品
- `GET /api/items/{item_id}` - 获取单个商品
- `POST /api/items` - 创建新商品
- `PUT /api/items/{item_id}` - 更新商品
- `DELETE /api/items/{item_id}` - 删除商品

### 用户 API

- `GET /api/users` - 获取所有用户
- `GET /api/users/{user_id}` - 获取单个用户
- `GET /api/users/stats` - 获取用户统计信息

### 系统 API

- `GET /api/system/health` - 健康检查
- `GET /api/system/info` - 系统信息

## 环境变量配置

项目使用 `.env` 文件进行环境变量配置，可以根据需要修改以下配置：

```
API_ENV=development    # 环境 (development, production)
API_PORT=8000          # 服务端口
API_HOST=0.0.0.0       # 服务主机
LOG_LEVEL=info         # 日志级别
```

## 开发指南

### 添加新的 API 路由

1. 在 `app/routers/` 目录下创建新的路由文件
2. 在新文件中定义 APIRouter 和路由处理函数
3. 在 `main.py` 中导入并注册新的路由

### 添加新的数据模型

在 `app/models.py` 文件中定义新的 Pydantic 模型

## 许可证

[MIT](https://opensource.org/licenses/MIT)