CRUD for GORM

Features

• ORM: GORM
• Base CRUD service
• Base CRUD repository
• Base CRUD controller

How to use

https://github.com/zubroide/go-api-boilerplate

package gin_crud

import (
	"github.com/gin-gonic/gin"
	"github.com/zubroide/gorm-crud"
	"net/http"
	"reflect"
	"strconv"
)


type ParametersHydratorInterface interface {
	Hydrate(context *gin.Context) (gorm_crud.ListParametersInterface, error)
}

type BaseParametersHydrator struct {
	logger gorm_crud.LoggerInterface
	ParametersHydratorInterface
}

func NewBaseParametersHydrator(logger gorm_crud.LoggerInterface) ParametersHydratorInterface {
	return &BaseParametersHydrator{logger: logger}
}

func (c BaseParametersHydrator) Hydrate(context *gin.Context) (gorm_crud.ListParametersInterface, error) {
	var parameters gorm_crud.CrudListParameters
	err := context.ShouldBindQuery(&parameters)
	return &parameters, err
}


type CrudControllerInterface interface {
	BaseControllerInterface
	Create(context *gin.Context)
	Get(context *gin.Context)
	List(context *gin.Context)
	Update(context *gin.Context)
	Delete(context *gin.Context)
}

type CrudController struct {
	CrudControllerInterface
	*BaseController
	service            gorm_crud.CrudServiceInterface
	parametersHydrator ParametersHydratorInterface
}

func NewCrudController(service gorm_crud.CrudServiceInterface, parametersHydrator ParametersHydratorInterface, logger gorm_crud.LoggerInterface) *CrudController {
	controller := NewBaseController(logger)
	return &CrudController{BaseController: controller, service: service, parametersHydrator: parametersHydrator}
}

func (c CrudController) Get(context *gin.Context) {
	recordId, err := strconv.Atoi(context.Params.ByName("id"))
	if err != nil {
		c.replyError(context, "Please specify record id", http.StatusBadRequest)
		return
	}

	data, err := c.service.GetItem(uint(recordId))

	if err != nil {
		c.replyError(context, "Record not found", http.StatusNotFound)
		return
	}

	c.replySuccess(context, data)
}

func (c CrudController) List(context *gin.Context) {
	parameters, err := c.parametersHydrator.Hydrate(context)

	if err != nil {
		c.replyError(context, "Cant parse request parameters", http.StatusBadRequest)
		return
	}

	data, err := c.service.GetList(parameters)

	if err != nil {
		c.replyError(context, "Data not found", http.StatusBadRequest)
		return
	}

	c.replySuccess(context, data)
}

func (c CrudController) Create(context *gin.Context) {
	model := c.service.GetModel()
	data := reflect.New(reflect.TypeOf(model).Elem()).Interface()
	if err := context.ShouldBindJSON(data); err != nil {
		c.replyError(context, "Cant parse request", http.StatusBadRequest)
		return
	}
	data = c.service.Create(data)
	c.replySuccess(context, data)
}

func (c CrudController) Update(context *gin.Context) {
	recordId, err := strconv.Atoi(context.Params.ByName("id"))
	if err != nil {
		c.replyError(context, "Cant parse request", http.StatusBadRequest)
		return
	}

	data, err := c.service.GetItem(uint(recordId))
	if err != nil {
		c.replyError(context, "Data not found", http.StatusBadRequest)
		return
	}

	if err := context.ShouldBindJSON(data); err != nil {
		c.replyError(context, "Cant parse request", http.StatusBadRequest)
		return
	}
	data = c.service.Update(data)

	c.replySuccess(context, data)
}

func (c CrudController) Delete(context *gin.Context) {
	recordId, err := strconv.Atoi(context.Params.ByName("id"))
	if err != nil {
		c.replyError(context, "Please specify record id", http.StatusBadRequest)
		return
	}

	err = c.service.Delete(uint(recordId))
	if err != nil {
		c.replyError(context, "Data not found", http.StatusBadRequest)
		return
	}

	c.replySuccess(context, nil)
}

Requirements

• Go 1.12+

License

MIT