【源码】基于Gin框架的模块化API开发框架

项目简介

本项目 go-gin-api 是基于 Gin 进行模块化设计的 API 框架。它封装了众多常用功能，使用简单，可助力快速业务研发。同时，框架增加了更多限制，有助于约束项目组开发成员，避免混乱无序及自由随意的编码。不过此项目主要供参考学习，线上使用需谨慎。

项目的主要特性和功能

1. 限流与异常处理：支持 rate 接口限流，panic 异常时邮件通知。
2. 跨域与指标记录：支持 cors 接口跨域，Prometheus 指标记录。
3. 文档与查询：支持 Swagger 接口文档生成，GraphQL 查询语言。
4. 链路追踪与性能剖析：支持项目内部链路追踪，pprof 性能剖析。
5. 错误码与日志：支持 errno 统一定义错误码，zap 日志收集。
6. 配置与数据库：支持 viper 配置文件解析，gorm 数据库组件。
7. 缓存与API规范：支持 go-redis 组件，RESTful API 返回值规范。
8. 代码生成与定时任务：支持生成数据表 CURD、控制器方法等代码生成器，cron 定时任务且可在后台界面配置。
9. 实时通讯与界面：支持 websocket 实时通讯，有后台界面演示，使用 Light Year Admin 模板提供 web 界面。

安装使用步骤

假设用户已经下载了本项目的源码文件。 1. 确保已经安装 Go 语言环境，并且配置好 GOPATH 等环境变量。 2. 打开终端，进入项目根目录。 3. 使用 go mod tidy 命令下载项目依赖。 4. 按照需求修改 viper 对应的配置文件。 5. 使用 go run main.go 启动项目。 6. 访问对应接口，可查看 Swagger 文档了解接口信息，通过 pprof 进行性能剖析等操作。

其他参考

• 中文文档：go-gin-api - 语雀

下载地址

点击下载 【提取码: 4003】【解压密码: www.makuang.net】