介绍
先说项目背景。这个 gin-api-mono 项目，是从 go-gin-api 里单独抽出来的后端部分。很多开发者其实并不需要原项目自带的前端功能，只想要一个纯粹的后端脚手架。作者看到了这个需求，干脆把后端代码拆成独立项目，方便大家直接拿着用。说白了，这就是一个为“只做 API 服务”而生的 Go 框架。
运行
按照 README 上的指引，我们来一次 Quick Start，看看这套东西跑起来到底有多快。
第一步，把数据库和表建好。一个空库加一张管理员表，数据顺手也插进去。
-- 1. 创建数据库 -- CREATE database gin_api_mono; USE gin_api_mono; -- 2. 创建数据表 -- CREATE TABLE `admin` ( `id` int(11) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键', `username` varchar(32) NOT NULL DEFAULT '' COMMENT '用户名', `mobile` varchar(20) NOT NULL DEFAULT '' COMMENT '手机号', `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间', PRIMARY KEY (`id`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='管理员表'; -- 3. 初始化数据 -- INSERT INTO `admin` (`id`, `username`, `mobile`) VALUES (1, '张三', '13888888888'), (2, '李四', '13888888888'), (3, '赵五', '13888888888');
然后，在 dev 配置文件里把数据库连接信息填上：
[mysql.read] addr = '127.0.0.1:3306' name = 'gin_api_mono' pass = '123456' user = 'root' [mysql.write] addr = '127.0.0.1:3306' name = 'gin_api_mono' pass = '123456' user = 'root'
配置搞定之后，启动项目：
go run main.go -env dev
如果看到下面这个输出，说明项目已经跑起来了：
██████╗ ██╗███╗ ██╗ █████╗ ██████╗ ██╗ ███╗ ███╗ ██████╗ ███╗ ██╗ ██████╗ ██╔════╝ ██║████╗ ██║ ██╔══██╗██╔══██╗██║ ████╗ ████║██╔═══██╗████╗ ██║██╔═══██╗ ██║ ███╗██║██╔██╗ ██║█████╗███████║██████╔╝██║█████╗██╔████╔██║██║ ██║██╔██╗ ██║██║ ██║ ██║ ██║██║██║╚██╗██║╚════╝██╔══██║██╔═══╝ ██║╚════╝██║╚██╔╝██║██║ ██║██║╚██╗██║██║ ██║ ╚██████╔╝██║██║ ╚████║ ██║ ██║██║ ██║ ██║ ╚═╝ ██║╚██████╔╝██║ ╚████║╚██████╔╝ ╚═════╝ ╚═╝╚═╝ ╚═══╝ ╚═╝ ╚═╝╚═╝ ╚═╝ ╚═╝ ╚═╝ ╚═════╝╚═╝ ╚═══╝ ╚═════╝
看看 swagger 文档长什么样：
用 Postman 调一下接口试试效果：
整个过程走下来非常顺，对新手来说是个不错的正反馈——能快速看到成果，才能保持继续深入的动力。接下来，我们试着用它快速写一个 TODO List 的 DEMO，看看这套框架对业务开发的实际提速效果。
TODO List
数据库
还是老规矩，先把数据表建好。用户就用刚才那张管理员表，我们只需要新建一张 TODO 表：
CREATE TABLE `todo` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键',
`user_id` int(11) NOT NULL COMMENT '用户ID',
`title` varchar(32) NOT NULL COMMENT '标题',
`desc` varchar(128) NOT NULL DEFAULT '' COMMENT '描述',
`created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
路由
先定两个简单的接口：
POST /api/todo：创建一个 todoPOST /api/todo/update：修改某个 todo
对应的路由注册代码：
todoHandler := todo.New(logger, db)
todoRouter := mux.Group("/api")
{
// 创建一个 todo
todoRouter.POST("/todo", todoHandler.Create())
// 修改某个 todo
todoRouter.POST("/todo/update", todoHandler.Update())
}
服务
接着写 handler 方法。先定义接口规范：
var _ Handler = (*handler)(nil)
type Handler interface {
i()
// Create 创建一个 todo
// @Tags API.todo
// @Router /api/todo [post]
Create() core.HandlerFunc
// Update 修改某个 todo
// @Tags API.todo
// @Router /api/todo/{id} [post]
Update() core.HandlerFunc
}
type handler struct {
logger *zap.Logger
db mysql.Repo
}
func New(logger *zap.Logger, db mysql.Repo) Handler {
return &handler{
logger: logger,
db: db,
}
}
func (h *handler) i() {}
下面是 Create 方法的核心实现：
// Create 创建一个 todo
// @Summary 创建一个 todo
// @Description 创建一个 todo
// @Tags API.todo
// @Accept json
// @Produce json
// @Param todo body createRequest true "TODO信息"
// @Success 200 {object} createResponse
// @Failure 400 {object} code.Failure
// @Router /api/todo [post]
func (h *handler) Create() core.HandlerFunc {
return func(ctx core.Context) {
req := new(createRequest)
res := new(createResponse)
if err := ctx.ShouldBindJSON(req); err != nil {
ctx.AbortWithError(core.Error(
http.StatusBadRequest,
code.ParamBindError,
validation.Error(err)).WithError(err),
)
return
}
// found admin
a := new(models.Admin)
adminResult := h.db.GetDbR().WithContext(ctx.RequestContext()).First(&a, req.UserID)
if adminResult.Error != nil {
ctx.AbortWithError(core.Error(
http.StatusBadRequest,
code.TodoCreateError,
code.Text(code.TodoCreateError)).WithError(adminResult.Error),
)
return
}
if a == nil {
ctx.AbortWithError(core.Error(
http.StatusBadRequest,
code.AdminNotFound,
code.Text(code.AdminNotFound)),
)
return
}
createData := new(models.Todo)
createData.UserID = req.UserID
createData.Title = req.Title
createData.Desc = req.Desc
dbResult := h.db.GetDbW().WithContext(ctx.RequestContext()).Create(createData)
if dbResult.Error != nil {
ctx.AbortWithError(core.Error(
http.StatusBadRequest,
code.TodoCreateError,
code.Text(code.TodoCreateError)).WithError(dbResult.Error),
)
return
}
res.Id = createData.Id
ctx.Payload(res)
}
}
写到这里，TODO 的 API 服务就完成了。接下来验证一下，用 Postman 发个创建请求看看结果：
总结
从上面的小例子来看，用 gin-api-mono 写简单的 CURD API，效率确实很高。整个框架把底层那些繁琐的东西都封装好了，开发者只需要专注于业务逻辑的实现。对新人来说，上手几乎没有额外的心智负担。如果想快速拿一个原型去验证产品思路，这个框架值得一试。
