这个开源项目就是: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
登录即可,登录成功后就会看到仪表盘界面。
在后台可配置邮件发件人信息,如下图所示:
邮件模板如下:
在后台可设置调用方 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) {
}
}
意义:本次需求的研发负责人通过定义 type interface{}
的方式,定义出需要开发的方法,执行代码生成工具,每个方法的空实现都会生成在一个单独的文件中,开发人员只需去实现各自方法即可,便于进行分工和代码管理。
通过 链路 ID
可以将 请求信息
、响应信息
、调用第三方 HTTP 接口的信息
、调用第三方 gRPC 接口的信息
、调试信息
、执行的 SQL 信息
、执行的 Redis 信息
串起来,记录到日志中。
点击某一行可查看日志详情。
通过 handlergen
生成的代码,自带接口文档。
项目中使用 prometheus
进行指标收集,项目中默认开启 metrics 记录,可以通过 http://127.0.0.1:9999/metrics 即可查看。
项目中使用 gqlgen
实现了 GraphQL 查询,会发现与 gqlgen init 初始化的 demo 不同,是因为代码已经集成到 go-gin-api 中,比如集成了项目 core 包中的 链路、日志 等。
目前仅实现了 Demo, resolver 使用的是模拟数据,不过使用可复用的 service 也已经实现了,在代码已注释,感兴趣的可以深入研究。
启动 Prometheus
的配置文件,可参考:
类似效果:
Loki
是一个水平可扩展,高可用性,多租户的日志聚合系统,有兴趣可以研究一下。
启用 Loki
的配置文件,可参考:
https://github.com/xinliangno...
https://www.yuque.com/xinlian...
如果您有好的想法和建议,欢迎加好友交流。
公司项目需求,要实现任务卡片在不同任务列表之间进行拖拽实现任务类别的更改。...
在做网站的时候,希望网页能实现一个效果,就是可以弹出一个网页窗口,用来显示...
测试试一下!...
基本语法 text-overflow的使用需配合hight,over-flow:hidden;white-space:nowrap...
在使用HTML表的时候有时候需要我们改变行距,但是改变margin,padding,collapse...
IE6/IE7/IE8/IE9中tbody的innerHTML不能赋值,重现代码如下 复制代码 代码如下: ...
Dreamweaver中的代码想要插入注释,该怎么添加呢?下面我们就来看看详细的教程。...
注 :目前比较流行的前端框架有Bootstrap、Foundation,这两都有着常用的网页设...
1.我不会挽留任何一个企图离开我的人,你是例外。 2.有些记忆,注定无法抹去,...
各位小伙伴们好,今天我们来聊一聊JavaScript 中的“类型系统”。 但是在开始之...