54 lines
1.2 KiB
Markdown
54 lines
1.2 KiB
Markdown
# 美搭 (Meida) API 服务
|
|
|
|
一个基于FastAPI构建的API服务项目。
|
|
|
|
## 项目结构
|
|
|
|
```
|
|
meida-api/
|
|
├── app/ # 应用目录
|
|
│ ├── api/ # API相关模块
|
|
│ │ └── v1/ # API版本1
|
|
│ ├── core/ # 核心配置
|
|
│ ├── db/ # 数据库相关
|
|
│ ├── models/ # 数据模型
|
|
│ ├── schemas/ # 数据验证模式
|
|
│ └── services/ # 业务服务层
|
|
├── main.py # 应用入口
|
|
└── requirements.txt # 项目依赖
|
|
```
|
|
|
|
## 安装与运行
|
|
|
|
1. 创建虚拟环境 (推荐)
|
|
```bash
|
|
python -m venv venv
|
|
source venv/bin/activate # Linux/Mac
|
|
# 或
|
|
venv\Scripts\activate # Windows
|
|
```
|
|
|
|
2. 安装依赖
|
|
```bash
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
3. 运行服务
|
|
```bash
|
|
python main.py
|
|
```
|
|
或
|
|
```bash
|
|
uvicorn main:app --reload
|
|
```
|
|
|
|
4. 访问API文档
|
|
- Swagger文档: http://localhost:8000/docs
|
|
- ReDoc文档: http://localhost:8000/redoc
|
|
|
|
## API端点
|
|
|
|
- `/api/v1/` - API基本信息
|
|
- `/api/v1/products` - 获取产品列表
|
|
- `/api/v1/products/{product_id}` - 获取特定产品详情
|
|
- `/health` - 健康检查 |