methods

Documentation

Index

• func BasicAuth(next http.HandlerFunc) http.HandlerFunc
• func CreateLogger(level string) *zap.Logger
• func RespondWithError(w http.ResponseWriter, code int, err error)
• func RespondWithJSON(w http.ResponseWriter, code int, payload interface{})
• func ToBSON_D(fields string, values string) bson.D
• func ToBSON_M(fields string, values string) bson.M
• func Validations(fl validator.FieldLevel) bool
• type Count
• type Keycloak
  • func (auth *Keycloak) VerifyToken(next http.HandlerFunc) http.HandlerFunc
  • func (auth *Keycloak) VerifyTokenPermissions(permissions string, next http.HandlerFunc) http.HandlerFunc
• type Links
  • func CreateLinks(r *http.Request, count Count) Links
• type MongoPaginate
  • func NewMongoPaginate(page int, limit int) *MongoPaginate
  • func (mp *MongoPaginate) GetPaginatedOpts() *options.FindOptions
• type ReturnObject

Functions

func BasicAuth

func BasicAuth(next http.HandlerFunc) http.HandlerFunc

basicAuth - adding basic authentication to route

func CreateLogger

func CreateLogger(level string) *zap.Logger

Create tailored logger

func RespondWithError

func RespondWithError(w http.ResponseWriter, code int, err error)

RespondWithError - creating JSON response with error

func RespondWithJSON

func RespondWithJSON(w http.ResponseWriter, code int, payload interface{})

RespondWithJSON - creating JSON response

func ToBSON_D

func ToBSON_D(fields string, values string) bson.D

func ToBSON_M

func ToBSON_M(fields string, values string) bson.M

func Validations

func Validations(fl validator.FieldLevel) bool

Validations implements validator.Func

Types

type Count

type Count struct {
	Total           int    `json:"total"`
	Page            int    `json:"page"`
	Limit           int    `json:"limit"`
	SelfPagingToken string `json:"selfpagingtoken"`
	PrevPagingToken string `json:"prevpagingtoken"`
	NextPagingToken string `json:"nextpagingtoken"`
}

Count - Model for Count

type Keycloak

type Keycloak struct {
	Logger       *zap.SugaredLogger
	Gocloak      *gocloak.GoCloak
	ClientId     string
	ClientSecret string
	Realm        string

	Permissions *[]gocloak.RequestingPartyPermission
	// contains filtered or unexported fields
}

Keycloak settings

func (*Keycloak) VerifyToken

func (auth *Keycloak) VerifyToken(next http.HandlerFunc) http.HandlerFunc

Validate access token. No detailed permissions

func (*Keycloak) VerifyTokenPermissions

func (auth *Keycloak) VerifyTokenPermissions(permissions string, next http.HandlerFunc) http.HandlerFunc

Validate access token. With detail permissions

type Links

type Links struct {
	Self  string `json:"self"`
	First string `json:"first"`
	Prev  string `json:"prev"`
	Next  string `json:"next"`
	Last  string `json:"last"`
}

Links - Model for Links

func CreateLinks

func CreateLinks(r *http.Request, count Count) Links

CreateLinks - Creating links for return object

type MongoPaginate

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

func NewMongoPaginate

func NewMongoPaginate(page int, limit int) *MongoPaginate

func (*MongoPaginate) GetPaginatedOpts

func (mp *MongoPaginate) GetPaginatedOpts() *options.FindOptions

type ReturnObject

type ReturnObject struct {
	Records any
	Count   Count
	Links   Links
}

ReturnObject - Model for ReturnObject