Go - 一个对新手很友好的项目(带界面)

2021年4月21日 236点热度 0人点赞 0条评论

这个开源项目就是：go-gin-api ，目前 800+ Star。

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

下载后可直接运行

$ git clone https://github.com/xinliangnote/go-gin-api
$ cd go-gin-api
$ go run main.go -env fat  // -env fat 设置为测试环境

首先进入到服务初始化界面。

接下来填写 MySQL、Redis 配置信息，填写完成后，点击初始化按钮。

如上图所示，表示服务初始化成功，需要再重新启动服务，服务启动后就会看到登录界面。

使用默认用户信息：admin，admin 登录即可，登录成功后就会看到仪表盘界面。

已集成哪些功能？

Panic 时邮件告警通知

在后台可配置邮件发件人信息，如下图所示：

邮件模板如下：

接口鉴权

在后台可设置调用方 KEY、调用方 SECRET、调用方对接人、备注等信息。

将创建的调用方的 KEY、SECRET 发给调用方即可，可以对调用方进行启用/禁用/删除等操作，还可以对其授权可访问的接口。

接口鉴权是基于 HTTP Header 中的两个参数 Authorization、Authorization-Date 存储签名信息，代码中提供了 3 种语言的加密算法：Go、PHP、JS。

代码生成工具

gormgen，基于数据表生成三个文件，以 admin 表为例会生成：gen_table.md 表注释的 MD 文档、gen_model.go 表字段的结构体、gen_admin.go 表 CURD 操作代码。

意义：在进行业务需求开发时，创建完数据表后，执行代码生成工具，常用的 CURD 操作全部生成完毕，使用的时候只需要 . 后面的方法即可，这样大大提高了业务开发效率。

handlergen，基于定义的 Handler 文件中 type interface{} 中接口方法，进行生成文件。

例如，定义的方法为：

// Login 管理员登录
// @Tags API.admin
// @Router /api/admin/login [post]
Login() core.HandlerFunc

生成后的方法为：

type loginRequest struct {
 
}

type loginResponse struct {
 
}

// Login 管理员登录
// @Summary 管理员登录
// @Description 管理员登录
// @Tags API.admin
// @Accept multipart/form-data
// @Produce json
// @Success 200 {object} loginResponse
// @Failure 400 {object} code.Failure
// @Router /api/admin/login [post]
func (h *handler) Login() core.HandlerFunc {
 return func(c core.Context) {
     
 }
}