betterrest

README

BetterREST

This experimental project aims to allow user to define only database schema to have the basic CRUD functionality provided by a REST interface.

Documentation

Index

• func RegDB(dbi *gorm.DB)
• func SetConfig(cfg Config)
• type Config
• type Registrar
  • func For(typeString string) *Registrar
  • func (r *Registrar) BatchCRUPDHooks(before func(bhpData models.BatchHookPointData, op models.CRUPDOp) error, ...) *Registrar
  • func (r *Registrar) BatchCreateHooks(before func(bhpData models.BatchHookPointData) error, ...) *Registrar
  • func (r *Registrar) BatchDeleteHooks(before func(bhpData models.BatchHookPointData) error, ...) *Registrar
  • func (r *Registrar) BatchPatchHooks(beforeApply func(bhpData models.BatchHookPointData) error, ...) *Registrar
  • func (r *Registrar) BatchReadHooks(after func(bhpData models.BatchHookPointData) error) *Registrar
  • func (r *Registrar) BatchRenderer(...) *Registrar
  • func (r *Registrar) BatchUpdateHooks(before func(bhpData models.BatchHookPointData) error, ...) *Registrar
  • func (r *Registrar) CustomCreate(modelObj models.IModel, f func(db *gorm.DB) (*gorm.DB, error)) *Registrar
  • func (r *Registrar) Model(modelObj models.IModel) *Registrar
  • func (r *Registrar) ModelWithOption(modelObj models.IModel, options models.RegOptions) *Registrar
  • func (r *Registrar) UserModel(modelObj models.IModel) *Registrar

Functions

func RegDB

func RegDB(dbi *gorm.DB)

RegDB register the db

func SetConfig

func SetConfig(cfg Config)

Types

type Config

type Config struct {
	Log bool
}

type Registrar

type Registrar struct {
	// contains filtered or unexported fields
}

Registrar has registration methods for models

func For

func For(typeString string) *Registrar

For set the current registering typeString

func (*Registrar) BatchCRUPDHooks

func (r *Registrar) BatchCRUPDHooks(
	before func(bhpData models.BatchHookPointData, op models.CRUPDOp) error,
	after func(bhpData models.BatchHookPointData, op models.CRUPDOp) error) *Registrar

BatchCRUPDHooks adds hookpoints which are called before CUPD (no read) and after batch CRUPD. Either one can be left as nil

func (*Registrar) BatchCreateHooks

func (r *Registrar) BatchCreateHooks(
	before func(bhpData models.BatchHookPointData) error,
	after func(bhpData models.BatchHookPointData) error) *Registrar

BatchCreateHooks adds hookpoints which are called before and after batch update. Either one can be left as nil

func (*Registrar) BatchDeleteHooks

func (r *Registrar) BatchDeleteHooks(
	before func(bhpData models.BatchHookPointData) error,
	after func(bhpData models.BatchHookPointData) error) *Registrar

BatchDeleteHooks adds hookpoints which are called before and after batch delete. Either one can be left as nil

func (*Registrar) BatchPatchHooks

func (r *Registrar) BatchPatchHooks(
	beforeApply func(bhpData models.BatchHookPointData) error,
	before func(bhpData models.BatchHookPointData) error,
	after func(bhpData models.BatchHookPointData) error) *Registrar

BatchPatchHooks adds hookpoints which are called before and after batch update. Either one can be left as nil

func (*Registrar) BatchReadHooks

func (r *Registrar) BatchReadHooks(after func(bhpData models.BatchHookPointData) error) *Registrar

BatchReadHooks adds hookpoints which are called after and read, can be left as nil

func (*Registrar) BatchRenderer

func (r *Registrar) BatchRenderer(renderer func(roles []models.UserRole, who models.Who, modelObj []models.IModel) []byte) *Registrar

BatchRenderer register custom batch renderer (do your own output, not necessarily JSON)

func (*Registrar) BatchUpdateHooks

func (r *Registrar) BatchUpdateHooks(
	before func(bhpData models.BatchHookPointData) error,
	after func(bhpData models.BatchHookPointData) error) *Registrar

BatchUpdateHooks adds hookpoints which are called before and after batch update. Either one can be left as nil

func (*Registrar) CustomCreate

func (r *Registrar) CustomCreate(modelObj models.IModel, f func(db *gorm.DB) (*gorm.DB, error)) *Registrar

CustomCreate register custom create table funtion

func (*Registrar) Model

func (r *Registrar) Model(modelObj models.IModel) *Registrar

Model adds a New function for an models.IModel (convenient function of RegModelWithOption)

func (*Registrar) ModelWithOption

func (r *Registrar) ModelWithOption(modelObj models.IModel, options models.RegOptions) *Registrar

ModelWithOption adds a New function for an models.IModel

func (*Registrar) UserModel

func (r *Registrar) UserModel(modelObj models.IModel) *Registrar

UserModel set the IModel type