Golang

关注公众号 jb51net

关闭
首页 > 脚本专栏 > Golang > gin-api-mono 创建 TODO

使用 gin-api-mono 创建简单的 TODO 服务

作者：-睡到自然醒~

本文主要介绍了使用 gin-api-mono 创建简单的 TODO 服务,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

介绍

首先介绍一下 gin-api-mono 这个项目，这个项目是由 go-gin-api 作者基于用户的需求衍生出来的一个项目。因为有些用户觉得 go-gin-api 是一个前后端都有的一个开源项目，对于很多用户来说，前端部分是不需要的，所以作者看到这层需求，从而将后端代码抽离出来成为 gin-api-mono 这个项目。

运行

现在我们基于 gin-api-mono 的 README.md 来进行一个 Quick Start：

首先我们创建一个 mysql database 以及一些表结构、数据等。

-- 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'

到此为止，我们已经成功配置好 gin-api-mono 的项目配置了，现在我们开始执行程序：

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;

路由

我们先简单的定义两个简单的路由：

	todoHandler := todo.New(logger, db)
	todoRouter := mux.Group("/api")
	{
		// 创建一个 todo
		todoRouter.POST("/todo", todoHandler.Create())
		// 修改某个 todo
		todoRouter.POST("/todo/update", todoHandler.Update())
	}

服务

现在我们来编写对应的 handler func。

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 创建一个 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)
	}
}

这样我们就编写好我们的 api 服务了，现在来稍微测试一下创建一个 todo，还是像上面一样，使用 postman 发出一个请求：

总结

从上面的一个简单的例子来看，进行一些简单的 CURL api 的编写还是非常快速的，可以使用这个框架进行快速开发，从而将产品快速推出市场进行验证。目前从简单的测试来看，应该对新人还是非常友好的，屏蔽了一些底层细节，专注在上层服务的编写，没有过高的心智负担。

到此这篇关于使用 gin-api-mono 创建简单的 TODO 服务的文章就介绍到这了,更多相关gin-api-mono 创建 TODO内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:
阅读全文