Go Blog Api

基于 Go 语言实现博客 API

技术栈

• Go 语言
• 框架路由使用 Gin 路由
• 中间件使用 Gin 框架的中间件
• 数据库组件 GORM
• 配置文件解析库 Viper
• 校验器使用 validator 也是 Gin 框架默认的校验器
• 任务调度 cron
• 包管理工具 Go Modules
• 高性能日志库Zap
• 使用 make 来管理 Go 工程
• 使用 shell(startup.sh) 脚本来管理进程
• 使用 supervisor 管理进程
• 使用 YAML 文件进行多环境配置
• 使用 Ide 自带 REST Client 工具测试 API
• 使用 Prometheus 监控 QPS、分位耗时等
• 使用钉钉告警

数据流

目录结构

├── cmd                          # 命令行工具
├── Makefile                     # 项目管理文件
├── configs                      # 配置文件统一存放目录
├── docs                         # 框架相关文档
├── internal                     # 业务目录
│   ├── crons                    # 定时任务
│   ├── handler                  # http 接口
│   ├── enum                     # 枚举值
│   ├── pkg                      # 内部应用程序代码
│   ├── routers                  # 业务路由
│   ├── service                  # 业务逻辑
│   ├── models                   # 数据模型
│   └── daos                     # 数据库操作
├── logs                         # 存放日志的目录
├── resource                     # 资源目录
├── main.go                      # 项目入口文件
├── pkg                          # 公共的 package
├── tests                        # 单元测试
└── startup.sh                   # 服务启动脚本

快速开始

# 下载安装，可以不用是 GOPATH
git clone https://github.com/convee/go-blog-api.git

# 进入到下载目录
cd go-blog-api

# 生成环境配置文件
cd config

vim config.yml

# 修改 mysql、redis配置

# 导入 sql


# 编译
make build

# 运行方式（后台运行）
nohup ./go-blog-api config.yml &

常用命令

• make help 查看帮助
• make dep 下载 Go 依赖包
• make build 编译项目
• make tar 打包文件

模块

开发规范

遵循: Uber Go 语言编码规范

开发规约

部署

# 1、构建
make build
# 2、打包
make tar 
# 3、上传打包文件到服务器目录
rz -y
# 4、上服务器解压
tar -zxvf govueblog-2023.tar.gz
# 5、部署服务（后台运行）
sh build/startup.sh
# 6、守护进程（supervisor）
[program:go-blog-api]
directory = /data/modules/go-blog-api
command = /data/modules/go-blog-api/goblogapi -c configs/config.yml
autostart = true
autorestart = true
startsecs = 5
user = root
redirect_stderr = true
stdout_logfile = /data/modules/go-blog-api/supervisor.log

数据库说明

接口文档