Skip to content

基于 gin 框架 API 项目脚手架 / Golang gin framework scaffolding

License

Notifications You must be signed in to change notification settings

zhan3333/go-framework

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

go-framework

gin 项目脚手架,包含完整的应用实例,清晰的依赖关系。

Getting Help

Email: grianchan@gmail.com

Feature

  • 使用 GORM v2
  • viper toml 配置文件加载与映射
  • 命令辅助开发调试
    • server 启动 http 服务
    • route list 显示注册的路由列表
  • gin 与中间件
  • 完整的项目实例
  • 自定义控制器 context
  • 单元测试支持加载框架,提供辅助 api 测试方法
  • 优秀的测试代码
    • 中间件测试
    • 接口测试
    • 单元测试

如何运行

前提:项目使用 module 模式运行。

配置 config/config.toml

cp configs/default.tmol configs/local.toml

运行

go run main.go server --config=configs/local.toml

编译

  • go build -o lgo main.go
  • ./lgo server --config=configs/local.toml // 固定读取 config 目录下的配置文件

测试

配置 env LGO_TEST_FILE={path}/configs/local.toml,测试中会自动加载框架

默认开启端口 http://127.0.0.1:8080 访问服务

Roadmap

  • 数据库
  • http 接口测试
  • 加载配置
  • 日志
  • 缓存
  • 数据库
  • 路由结构
  • GORM
  • Swagger
  • 中间件
  • 注册自定义表单验证规则
  • faker 结构体数据填充
  • faker 数据填充
  • [] 中间件
    • JWT 中间件加入
    • cors 跨域中间件 (github.com/gin-contrib/cors)
    • [] 请求速率 rate limiter 中间件
  • pprof 性能监控 (使用 go tool pprof http://localhost:8090/debug/pprof/heap 访问)
  • 配置模块改用 github.com/BurntSushi/toml
  • 使用 context 传递上下文
  • [] grpc 服务端
  • [] grpc 客户端
  • [] kafka 消息队列
  • 升级到 go1.18
  • 使用 cobra 创建命令行工具
  • [] github Action CI

相关文档

gin 框架

faker 结构体数据填充

gorm ORM

log 日志

validate 参数校验

Redis

Swag

gin 官方中间件

gin-pprof

About

基于 gin 框架 API 项目脚手架 / Golang gin framework scaffolding

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages