routes

Documentation

Index

• Variables
• type App
  • func NewApp(config *Config) *App
  • func (a *App) AddApp(routeInterface Interface)
  • func (a *App) Listen(host string, port int) error
• type Base
  • func (ctrl *Base) AddRoute(route *Route)
  • func (ctrl *Base) GetIdParams(c *fiber.Ctx, key string) (primitive.ObjectID, *gerror.Error)
  • func (ctrl *Base) GetParams(c *fiber.Ctx, key string) (string, *gerror.Error)
  • func (ctrl *Base) GetToken(ctx *fiber.Ctx) string
  • func (ctrl *Base) GetUser(ctx *fiber.Ctx) jwt.Claims
  • func (ctrl *Base) Routes(app *fiber.App)
• type Config
  • func NewConfig() *Config
• type Interface
• type Route
  • func Delete(path string, handler fiber.Handler, auth bool, roles ...string) *Route
  • func Get(path string, handler fiber.Handler, auth bool, roles ...string) *Route
  • func Post(path string, handler fiber.Handler, auth bool, roles ...string) *Route
  • func Put(path string, handler fiber.Handler, auth bool, roles ...string) *Route
  • func Static(path string, handler fiber.Handler) Route

Variables

var MethodDelete = "DELETE"

var MethodGet = "GET"

var MethodOptions = "OPTIONS"

var MethodPatch = "PATCH"

var MethodPost = "POST"

var MethodPut = "PUT"

Types

type App

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

func NewApp

func NewApp(config *Config) *App

func (*App) AddApp

func (a *App) AddApp(routeInterface Interface)

func (*App) Listen

func (a *App) Listen(host string, port int) error

type Base

type Base struct {
	Auth   *auth.Auth
	Logger *logger.Logger
	Prefix string
	// contains filtered or unexported fields
}

func (*Base) AddRoute

func (ctrl *Base) AddRoute(route *Route)

func (*Base) GetIdParams

func (ctrl *Base) GetIdParams(c *fiber.Ctx, key string) (primitive.ObjectID, *gerror.Error)

func (*Base) GetParams

func (ctrl *Base) GetParams(c *fiber.Ctx, key string) (string, *gerror.Error)

func (*Base) GetToken

func (ctrl *Base) GetToken(ctx *fiber.Ctx) string

func (*Base) GetUser

func (ctrl *Base) GetUser(ctx *fiber.Ctx) jwt.Claims

func (*Base) Routes

func (ctrl *Base) Routes(app *fiber.App)

type Config

type Config struct {
}

func NewConfig

func NewConfig() *Config

type Interface

type Interface interface {
	Routes(app *fiber.App)
	AddRoute(route *Route)
}

type Route

type Route struct {
	Path    string
	Method  string
	Handler fiber.Handler
	Role    []string
	Auth    bool
	Static  bool
	Log     bool
}

func Delete

func Delete(path string, handler fiber.Handler, auth bool, roles ...string) *Route

func Get

func Get(path string, handler fiber.Handler, auth bool, roles ...string) *Route

func Post

func Post(path string, handler fiber.Handler, auth bool, roles ...string) *Route

func Put

func Put(path string, handler fiber.Handler, auth bool, roles ...string) *Route

func Static

func Static(path string, handler fiber.Handler) Route