StreamBox/README.md

909 B

StreamBox

Go + Gin 项目框架

目录结构

.
├── cmd/server      # 程序入口
├── config          # 配置文件
├── internal
│   ├── handler     # HTTP 处理层
│   ├── service     # 业务逻辑层
│   ├── model       # 数据模型
│   ├── middleware  # 中间件
│   └── router      # 路由注册
├── pkg
│   ├── logger      # Zap 日志封装
│   └── response    # 统一响应封装
├── api             # API 文档
└── docs            # 项目文档

快速开始

# 安装依赖
make tidy

# 启动服务
make run
# 或
# go run ./cmd/server

# 打包
make build
./bin/streambox

配置

  • config/config.yaml 主配置
  • 环境变量优先于配置文件,通过 viper.AutomaticEnv 覆盖

路由

  • GET /health 健康检查
  • GET /api/v1/ping 示例接口