# oc-web-back

**Repository Path**: zhengnici/oc-web-back

## Basic Information

- **Project Name**: oc-web-back
- **Description**: oc官网后端
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-11
- **Last Updated**: 2025-11-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OC Web后端服务

基于FastAPI构建的后端应用，提供RESTful API接口，包含数据库集成、身份认证和配置管理功能。

## 功能特性

- FastAPI框架，高性能API开发
- MySQL数据库集成（SQLAlchemy ORM）
- JWT身份认证与安全令牌管理
- YAML配置系统，支持环境特定设置
- 完整测试套件（pytest）

## 安装指南

### 前置要求
- Python 3.11+ 版本
- MySQL数据库服务器
- Pipenv依赖管理工具

### 克隆代码库
```bash
git clone <仓库地址>
cd oc-web-back
```

### 安装依赖包
```bash
pipenv install --dev
```

## 配置说明

1. 复制示例配置文件并根据环境修改：
```bash
cp config.yml.example config.yml
```

2. 生成安全的密钥并更新`config.yml`中的`app.secret_key`：
```bash
python -c "import secrets; print(secrets.token_urlsafe(32))"
```

3. 更新`config.yml`中的数据库连接信息和其他设置：
```yaml
app:
  project_name: OC Web后端服务
  secret_key: 你的安全密钥
  algorithm: HS256
  access_token_expire_minutes: 30
  cors_origins:
    - http://localhost:3000
database:
  url: mysql://用户名:密码@localhost:3306/数据库名
server:
  port: 8000
```

## 使用方法

### 激活虚拟环境
```bash
pipenv shell
```

### 启动开发服务器
```bash
python run.py
# 或
uvicorn app.main:app --reload --port 8000
```

API服务将在 http://localhost:8000 可用

## API文档

FastAPI自动生成交互式API文档：
- Swagger UI: http://localhost:8000/docs
- ReDoc: http://localhost:8000/redoc

## 测试指南

使用pytest运行测试套件：
```bash
pytest tests/ -v
```

## 项目结构
```
oc-web-back/
├── app/
│   ├── api/           # API路由和端点
│   ├── core/          # 核心配置和工具
│   │   ├── config.py  # 配置加载和设置
│   │   └── security.py # 认证和安全工具
│   ├── crud/          # 数据库CRUD操作
│   ├── db/            # 数据库连接和模型
│   ├── models/        # SQLAlchemy模型
│   └── schemas/       # Pydantic请求/响应模型
├── tests/             # 测试目录
├── config.yml         # 应用配置
├── config.yml.example # 示例配置
├── Pipfile            # 项目依赖
└── run.py             # 应用入口文件
```

## 许可证

[MIT许可证](LICENSE)