基于 Gin 进行模块化设计的 API 框架，致力于进行快速的业务研发

Posted 2023-03-09

参考技术A 基于 Gin 进行模块化设计的 API 框架，封装了常用功能，使用简单，致力于进行快速的业务研发。比如，支持 cors 跨域、jwt 签名验证、zap 日志收集、panic 异常捕获、trace 链路追踪、prometheus 监控指标、swagger 文档生成、viper 配置文件解析、gorm 数据库组件、graphql 查询语言、errno 统一定义错误码、gRPC 的使用 等等。

使用MIT开源协议

首次启动程序之后，会在浏览器中自动打开安装界面，链接地址：http://127.0.0.1:9999/install。

因为程序会使用到 Redis 和 mysql，所以安装前请输入 Redis、MySQL 配置信息。

点击初始化按钮，会将用到的数据表和默认数据进行初始化，在右侧可以看到初始化的日志信息。

如上，初始化成功后，初始化的表结构 UML 图如下：

重新启动程序，会在浏览器中自动打开登录界面，链接地址：http://127.0.0.1:9999/login 。

输入默认账号 admin，密码 admin 即可登录成功。

显示 项目信息、内存信息、硬盘信息、CPU信息 等。

在这里可以配置系统告警的发件人和收件人，当系统发生 Panic 时，进行邮件通知，邮件模板如下：

展示系统中定义的错误码。

在左侧可以单选或多选数据表，进行代码生成。

在左侧可以设置需要生成的 handler 名称。

设置谁可以调用我的接口，同时还可以授权调用我哪些接口。

设置谁可以登录后台，可以对其进行 禁用、重置密码、菜单授权、下线、删除 等操作。

设置后台侧边栏的菜单。

查询 Redis 缓存内容 和 有效期，同时还可以清空缓存。

查询 MySQL 数据，支持输入 SQL 语句执行和分析。

不同版本提供相应的升级指导。

程序中对传递 id 的场景，均使用密文进行传递。

展示最新的 100 条调用日志。

根据指标可以在 Grafana 生成类似的指标图。

go-gin-api 是基于 Gin 进行模块化设计的 API 框架，封装了常用的功能，使用简单，致力于进行快速的业务研发，同时增加了更多限制，约束项目组开发成员，规避混乱无序及自由随意的编码。

供参考学习，线上使用请谨慎！

集成组件：

连接DB，默认是 0 ；

私信回复：模块化API框架

或访问一飞开源：https://code.exmay.com/