http

Documentation

Index

• Variables
• func GetClientIP(r *http.Request) string
• func NewMiddlewares(middlewares ...func(next http.Handler) http.Handler) *[]func(next http.Handler) http.Handler
• func NewSubmodules(submodules ...*Module) *[]*Module
• type Module
  • func (m *Module) Create(baseRouter gonethttproute.RouterWrapper) error
  • func (m *Module) GetRouter() gonethttproute.RouterWrapper

Variables

var (
	ErrCookieNotFound     = errors.New("cookie not found")
	ErrNilRequestBody     = errors.New("request body cannot be nil")
	ErrInvalidRequestBody = "invalid request body type, expected: %v"
	ErrInDevelopment      = errors.New("in development")
	ErrNilSubmodule       = "%s: submodule at index %d is nil"
)

var (
	ErrCodeCookieNotFound *string
)

Functions

func GetClientIP

func GetClientIP(r *http.Request) string

GetClientIP returns the client's IP address from the request

func NewMiddlewares

func NewMiddlewares(middlewares ...func(next http.Handler) http.Handler) *[]func(next http.Handler) http.Handler

NewMiddlewares is a function that creates a new middlewares slice

func NewSubmodules

func NewSubmodules(submodules ...*Module) *[]*Module

NewSubmodules is a function that creates a new submodules slice

Types

type Module

type Module struct {
	Pattern          string
	Service          interface{}
	Controller       interface{}
	BeforeLoadFn     func(m *Module)
	RegisterRoutesFn func(m *Module)
	AfterLoadFn      func(m *Module)
	Middlewares      *[]func(next http.Handler) http.Handler
	Submodules       *[]*Module
	gonethttproute.RouterWrapper
}

Module is the struct for the route module

func (*Module) Create

func (m *Module) Create(
	baseRouter gonethttproute.RouterWrapper,
) error

Create is a function that creates the router for the controller and its submodules, and loads the module

func (*Module) GetRouter

func (m *Module) GetRouter() gonethttproute.RouterWrapper

GetRouter returns the router