crud

Documentation

Index

• Variables
• func GetConfiguredFlags(path, name string) func(*flag.FlagSet, string) Config
• type App
  • func New(config Config, service Service) (App, error)
• type Config
• type Error
  • func NewError(field, label string) Error
  • func (e Error) Error() string
• type Service

Variables

var (
	// ErrServiceIsRequired occurs when underlying service is not provided
	ErrServiceIsRequired = errors.New("service is required")

	// ErrNotFound occurs when item is not found
	ErrNotFound = errors.New("not found")

	// ErrInvalid occurs when invalid action is requested
	ErrInvalid = errors.New("invalid")

	// ErrUnauthorized occurs when authentication not provided
	ErrUnauthorized = errors.New("authentication required")

	// ErrForbidden occurs when action is forbidden
	ErrForbidden = errors.New("forbidden")

	// ErrInternal occurs when unhandled behavior occurs
	ErrInternal = errors.New("internal server error")
)

Functions

func GetConfiguredFlags

func GetConfiguredFlags(path, name string) func(*flag.FlagSet, string) Config

GetConfiguredFlags adds flags for configuring package

Types

type App

type App interface {
	Handler() http.Handler
	Swagger() (swagger.Configuration, error)
}

App of package

func New

func New(config Config, service Service) (App, error)

New creates new App from Config

type Config

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

Config of package

type Error

type Error struct {
	Field string `json:"field"`
	Label string `json:"label"`
}

Error describes a crud error

func NewError

func NewError(field, label string) Error

NewError creates a new error

func (Error) Error

func (e Error) Error() string

Error format error to string

type Service

type Service interface {
	Unmarshal(data []byte, contentType string) (interface{}, error)
	Check(ctx context.Context, old, new interface{}) []Error
	List(ctx context.Context, page, pageSize uint, sortKey string, sortDesc bool, filters map[string][]string) ([]interface{}, uint, error)
	Get(ctx context.Context, ID uint64) (interface{}, error)
	Create(ctx context.Context, o interface{}) (interface{}, error)
	Update(ctx context.Context, o interface{}) (interface{}, error)
	Delete(ctx context.Context, o interface{}) error
}

Service retrieves item