386666660f
Some checks failed
部署后端服务 / 🚀 构建并部署 (push) Failing after 7m20s
- 重构根目录CLAUDE.md为项目总览（60行精简版） - 细化backend模块CLAUDE.md为开发指南 - 新增各子模块CLAUDE.md文件： - api/desc/ - API定义模块 - internal/handler/ - 请求处理器 - internal/logic/ - 业务逻辑层 - internal/model/ - 数据模型层 - internal/middleware/ - 中间件层 - internal/svc/ - 服务上下文 - configs/ - 配置目录 - deploy/ - 部署配置 - pkg/ - 公共库 - scripts/ - 工具脚本 - configs/sql/ - SQL脚本 - 修复PostgreSQL SSL配置参数 - 清理旧的backend-old目录 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
73 lines
1.6 KiB
Markdown
73 lines
1.6 KiB
Markdown
# Backend API - 开发指南
|
|
|
|
> 🔧 Go + go-zero 后端API服务
|
|
|
|
## 🚀 快速开始
|
|
|
|
```bash
|
|
# 1. 进入目录
|
|
cd backend/
|
|
|
|
# 2. 启动服务
|
|
make run # 本地开发
|
|
make docker-run # Docker运行
|
|
```
|
|
|
|
## 📁 核心目录
|
|
|
|
```
|
|
backend/
|
|
├── cmd/api/main.go # 服务入口
|
|
├── api/desc/ # API定义文件
|
|
├── internal/ # 业务代码
|
|
│ ├── handler/ # 请求处理器
|
|
│ ├── logic/ # 业务逻辑
|
|
│ ├── model/ # 数据模型
|
|
│ └── middleware/ # 中间件
|
|
├── etc/ # 配置文件
|
|
├── tests/ # 测试文件
|
|
└── pkg/ # 公共库
|
|
```
|
|
|
|
## ⚙️ 配置文件
|
|
|
|
### 本地开发 (`etc/photographyapi-api.yaml`)
|
|
```yaml
|
|
Database:
|
|
driver: sqlite
|
|
file_path: ./data/photography.db
|
|
```
|
|
|
|
### 生产环境 (`etc/photography-api.yaml`)
|
|
```yaml
|
|
Database:
|
|
driver: postgres
|
|
host: postgres_db
|
|
port: 5432
|
|
ssl_mode: disable
|
|
```
|
|
|
|
## 🛠️ 常用命令
|
|
|
|
| 命令 | 用途 |
|
|
|---|---|
|
|
| `make run` | 启动开发服务器 |
|
|
| `make build` | 构建二进制 |
|
|
| `make docker-build` | 构建Docker镜像 |
|
|
| `make migrate-up` | 运行数据库迁移 |
|
|
| `make test` | 运行测试 |
|
|
|
|
## 🔗 API文档
|
|
- 定义文件: `api/desc/` 目录
|
|
- 在线测试: 启动后访问 http://localhost:8080
|
|
|
|
## 🗄️ 数据库
|
|
- **开发**: SQLite (无需安装)
|
|
- **生产**: PostgreSQL
|
|
- **迁移**: 自动迁移系统
|
|
|
|
## 📋 开发流程
|
|
1. 修改API定义 → `api/desc/`
|
|
2. 生成代码 → `make generate`
|
|
3. 实现逻辑 → `internal/logic/`
|
|
4. 运行测试 → `make test` |