go-snake 正在参加 2020 年度 OSC 中国开源项目评选,请投票支持!
go-snake 在 2020 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
投票让它出道
已投票
授权协议: MIT
开发语言: Google Go SHELL
操作系统: 跨平台
收录时间: 2020-04-10
提 交 者: 如来神掌

一款适合于快速开发业务的 Go 框架,主要是提供 API 服务。

技术栈

  • 框架路由使用 gin 路由
  • 中间件使用 gin 框架的中间件
  • 数据库组件 gorm
  • 文档使用 swagger 生成
  • 配置文件解析库 viper
  • 使用 JWT 进行身份鉴权认证
  • 校验器 validator 也是 gin 框架默认的校验器,当前最新是v9版本
  • 任务调度 cron
  • 包管理工具 go module
  • 测试框架 goConvey
  • CI/CD Github Actions
  • 容器化 Docker

特性

  • 遵循 RESTful API 设计规范
  • 基于 GIN WEB 框架,提供了丰富的中间件支持(用户认证、跨域、访问日志、请求频率限制、追踪 ID 等)
  • 基于 GORM 的数据库存储
  • JWT 认证
  • 支持 Swagger 文档(基于swaggo)
  • 使用 make 来管理Go工程
  • 使用 shell(admin.sh) 脚本来管理进程
  • 支持多环境运行
  • todo: 单元测试(基于net/http/httptest包,覆盖所有接口层的测试)
  • todo: 使用github actions 进行CI/CD
  • todo: 使用docker进行快速部署

目录结构

├── Makefile                     # 项目管理文件
├── admin.sh                     # 进程的start|stop|status|restart控制文件
├── conf                         # 配置文件统一存放目录
├── config                       # 专门用来处理配置和配置文件的Go package                 
├── db.sql                       # 在部署新环境时,可以登录MySQL客户端,执行source db.sql创建数据库和表
├── docs                         # swagger文档,执行 swag init 生成的
├── handler                      # 类似MVC架构中的C,用来读取输入,并将处理流程转发给实际的处理函数,最后返回结果
├── log                          # 存放日志的目录
├── main.go                      # 项目入口文件
├── model                        # 数据库model
├── pkg                          # 一些封装好的package
├── repository                   # 数据访问层
├── router                       # 路由及中间件目录
├── service                      # 业务逻辑封装
├── schedule                     # 任务调度配置目录
├── util                         # 业务工具包
└── wrktest.sh                   # API 性能测试脚本

错误码设计

看这里

启动项目

// 下载依赖
make dep

// 编译项目
make build

// 本地环境
cp config.sample.yaml config.local.yaml

// 运行
./snake -c conf/config.local.yaml

常用命令

  • make help 查看帮助
  • make dep 下载go依赖包
  • make build 编译项目
  • make swag-init 生成接口文档(需要重新编译)
  • make test-coverage 生成测试覆盖
  • make lint 检查代码规范
展开阅读全文

代码

的 Gitee 指数为
超过 的项目

go-snake 的相关资讯

go-snake 的相关博客

A - Fox And Snake

Problem description Fox Ciel starts to learn programming. The first task is drawing a fox! However, that turns out to...

snake_case 和camelCase

snake_case被称为蛇形命名法,一般是用来命名变量名称的,snakecase要求短语内的各个单词或缩写之间以(下划线)做间隔,如use...

CF1153E Serval and Snake

CF1153E Serval and Snake 题意简单版: 在$n\times m$的方格上有一条链(蛇),你需要通过查询来找出这条链的两个端点。 你的...

snake eating food

pygame 初始化 # 初始化游戏 pygame.init() # 初始化pygame screen = pygame.display.set_mode([SCREEN_WIDTH, SCREEN_HEIGH...

HTML5 snake

snake

android google snake

代码下载 - 公共邮箱(注意看邮件时间,免得被些无聊东东...) 邮箱: code_share@163.com 密码:code_share1 2011年4月15日 23:1...

python版贪食蛇snake

python版snake

CF1153E Serval and Snake(交互题)

题目 CF1153E Serval and Snake 很有意思的一道交互题 做法 我们观察到,每次查询一行,当这一行仅包含一端是返回的答案是奇数...

CTF-Pwn-[BJDCTF 2nd]snake_dyn

CTF-Pwn-[BJDCTF 2nd]snake_dyn 博客说明 文章所涉及的资料来自互联网整理和个人总结,意在于个人学习和经验汇总,如有什么地...

【C语言】Greedy Snake-2013-10

是一款有声有色的贪吃蛇游戏。它发源于传统但又有创新。它的特点是集声音和动画为一体、可设置游戏快慢、可用鼠标和键盘操作、...

go-snake 的相关问答

还没有任何问答,马上提问

评论 (0)

加载中
更多评论
0 评论
16 收藏
分享
返回顶部
顶部