fiber

Documentation

Overview

Package fiber provides utility functions for gofiber v2, jwt-go With additional validation functions, sending JSON response and parsing request bodies, getting JWT claims

Index

• func AuthenticationMiddleware(j JWTConfig) func(*fiber.Ctx) error
• func CheckFieldLength(field, title string, max, min int) (ok bool, message string)
• func GenerateJWTSignedString(claimMaps fiber.Map) (string, error)
• func GetJSONFieldValues(q interface{}) map[string]string
• func GetJWTClaim(key string) map[string]interface{}
• func GetJWTClaimOfType(key string, valueType interface{}) error
• func GetJWTClaims() jwt.MapClaims
• func LogError(err error)
• func ParseBody(in interface{}) error
• func SendBadRequestResponse(message string) error
• func SendJSONMessage(message string, isSuccess bool, httpStatusCode int) error
• func SendSuccessResponse(message string) error
• func ValidateField(field, title string, isMandatory bool, max, min int, format string) (ok bool, message string)
• func ValidateJSONField(q interface{}, tag string, isMandatory bool, max, min int, format string) (bool, string)
• type Context
  • func (ctx *Context) New(c *fiber.Ctx)
• type JWTConfig
• type Message

Functions

func AuthenticationMiddleware

func AuthenticationMiddleware(j JWTConfig) func(*fiber.Ctx) error

AuthenticationMiddleware ...

func CheckFieldLength

func CheckFieldLength(field, title string, max, min int) (ok bool, message string)

CheckFieldLength Validation of strings' length and return if valid based on maximum and minimum length specified and error message if invalid

func GenerateJWTSignedString

func GenerateJWTSignedString(claimMaps fiber.Map) (string, error)

GenerateJWTSignedString ...

func GetJSONFieldValues

func GetJSONFieldValues(q interface{}) map[string]string

GetJSONFieldValues Returns a map of JSON keys and values of a struct

func GetJWTClaim

func GetJWTClaim(key string) map[string]interface{}

GetJWTClaim Wrapper function for getting a JWT claim by key

func GetJWTClaimOfType

func GetJWTClaimOfType(key string, valueType interface{}) error

GetJWTClaimOfType ...

func GetJWTClaims

func GetJWTClaims() jwt.MapClaims

GetJWTClaims Get User JWT claims of the current context

func LogError

func LogError(err error)

LogError Logs errors

func ParseBody

func ParseBody(in interface{}) error

ParseBody Parses the request body from the copied current context

func SendBadRequestResponse

func SendBadRequestResponse(message string) error

SendBadRequestResponse Wrapper function for SendJSONMessage of 400 Bad request

func SendJSONMessage

func SendJSONMessage(message string, isSuccess bool, httpStatusCode int) error

SendJSONMessage Sends JSON Message with HTTP Status code to current context

func SendSuccessResponse

func SendSuccessResponse(message string) error

SendSuccessResponse Wrapper function for SendJSONMessage of 200 Success

func ValidateField

func ValidateField(field, title string, isMandatory bool, max, min int, format string) (ok bool, message string)

ValidateField Validation of strings and return if valid based on specification and error message if invalid

func ValidateJSONField

func ValidateJSONField(q interface{}, tag string, isMandatory bool, max, min int, format string) (bool, string)

ValidateJSONField Wrapper function for JSON field validation of a struct

Types

type Context

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

Context GoFiber Context

var Ctx Context

Ctx Context to be initiated by the New function

func (*Context) New

func (ctx *Context) New(c *fiber.Ctx)

New Copies GoFiber context as new current context

type JWTConfig

type JWTConfig struct {
	Duration     time.Duration
	CookieMaxAge int
	SetCookies   bool
	SecretKey    []byte
}

JWTConfig configuration for JWT

type Message

type Message struct {
	Message string `json:"message"`
	Status  string `json:"status"`
}

Message struct for GoFiber context response