apiutil

Documentation

Index

• func ErrorJson(w http.ResponseWriter, err error)
• func LoadConfig[I any](path string) (I, error)
• func NewHTTPError(message, detail string, code int) error
• func NewPostgresPool(dsn string, waitTime time.Duration) *pgxpool.Pool
• func ReadJson[I any](w http.ResponseWriter, r *http.Request) (I, error)
• func ReadJsonAndValidate[I any](w http.ResponseWriter, r *http.Request, ...) (I, error)
• func SetMaxBytes(mb int)
• func ValidateRequest(requestPayload any, ...) error
• func WriteJson(w http.ResponseWriter, status int, data any, headers ...http.Header)
• type ChiController
• type HTTPError
  • func (e HTTPError) Error() string
• type JWTMaker
  • func (j JWTMaker[P]) CreateToken(payload P, tokenType TokenType) (string, P, error)
  • func (j JWTMaker[P]) Middleware(store *sessions.CookieStore, sessionName string, tokenType TokenType) func(http.Handler) http.Handler
  • func (j JWTMaker[P]) TokenFromRequest(request *http.Request, tokenType TokenType) (P, error)
  • func (j JWTMaker[P]) VerifyToken(s string, tokenType TokenType) (P, error)
• type JWTPayload
  • func (j JWTPayload) GetAudience() (jwt.ClaimStrings, error)
  • func (j JWTPayload) GetExpirationTime() (*jwt.NumericDate, error)
  • func (j JWTPayload) GetIssuedAt() (*jwt.NumericDate, error)
  • func (j JWTPayload) GetIssuer() (string, error)
  • func (j JWTPayload) GetNotBefore() (*jwt.NumericDate, error)
  • func (j JWTPayload) GetSubject() (string, error)
• type PasetoMaker
  • func (p PasetoMaker[P]) CreateToken(payload P, tokenType TokenType) (string, P, error)
  • func (p PasetoMaker[P]) Middleware(store *sessions.CookieStore, sessionName string, tokenType TokenType) func(http.Handler) http.Handler
  • func (p PasetoMaker[P]) TokenFromRequest(request *http.Request, tokenType TokenType) (P, error)
  • func (p PasetoMaker[P]) VerifyToken(s string, tokenType TokenType) (P, error)
• type TokenMaker
  • func NewJWTMaker[P TokenPayload](durations map[TokenType]time.Duration, ...) TokenMaker[P]
  • func NewPasetoMaker[P TokenPayload](durations map[TokenType]time.Duration, ...) TokenMaker[P]
• type TokenPayload
• type TokenType

Functions

func ErrorJson

func ErrorJson(w http.ResponseWriter, err error)

ErrorJson writes a json response with the specified error. A non HTTPError type will follow:

• Status: 400
• Message: "bad request"
• Detail: error.Error()

func LoadConfig

func LoadConfig[I any](path string) (I, error)

func NewHTTPError

func NewHTTPError(message, detail string, code int) error

NewHTTPError registers a new HTTP error with its message, detail and code and returns the error

func NewPostgresPool

func NewPostgresPool(dsn string, waitTime time.Duration) *pgxpool.Pool

NewPostgresPool creates a new postgres connection pool.

func ReadJson

func ReadJson[I any](w http.ResponseWriter, r *http.Request) (I, error)

ReadJson reads a json request body into the specified struct. The maximum read bytes is defined by `maxBytes`.

func ReadJsonAndValidate

func ReadJsonAndValidate[I any](w http.ResponseWriter, r *http.Request, customValidatorsSlice ...map[string]func(p validator.FieldLevel) bool) (I, error)

ReadJsonAndValidate reads a json request body into the specified struct and validates it. The maximum read bytes is defined by `maxBytes`. The customValidators parameter is a map of field name to custom validation function.

func SetMaxBytes

func SetMaxBytes(mb int)

SetMaxBytes sets the maximum number of bytes allowed in the request body. Default is 10485760.

func ValidateRequest

func ValidateRequest(requestPayload any, customValidatorsSlice ...map[string]func(level validator.FieldLevel) bool) error

ValidateRequest validates the request payload using the Go Playground Validator. Use the `validate` tag on the struct fields to specify the validation rules. The customValidators map can be used to register custom validation rules.

func WriteJson

func WriteJson(w http.ResponseWriter, status int, data any, headers ...http.Header)

WriteJson writes a json response with the specified status and data.

Types

type ChiController

type ChiController interface {
	Routes() *chi.Mux
}

ChiController is an interface for Chi controllers.

type HTTPError

type HTTPError struct {
	Message string `json:"message"`
	Detail  string `json:"detail"`
	Status  int    `json:"status"`
}

func (HTTPError) Error

func (e HTTPError) Error() string

type JWTMaker

type JWTMaker[P TokenPayload] struct {
	// contains filtered or unexported fields
}

func (JWTMaker[P]) CreateToken

func (j JWTMaker[P]) CreateToken(payload P, tokenType TokenType) (string, P, error)

func (JWTMaker[P]) Middleware

func (j JWTMaker[P]) Middleware(store *sessions.CookieStore, sessionName string, tokenType TokenType) func(http.Handler) http.Handler

func (JWTMaker[P]) TokenFromRequest

func (j JWTMaker[P]) TokenFromRequest(request *http.Request, tokenType TokenType) (P, error)

func (JWTMaker[P]) VerifyToken

func (j JWTMaker[P]) VerifyToken(s string, tokenType TokenType) (P, error)

type JWTPayload

type JWTPayload struct {
	jwt.Claims
	MarshalledPayload string `json:"payload"`
	IssuedAt          int64  `json:"iat"`
	ExpiresAt         int64  `json:"exp"`
}

func (JWTPayload) GetAudience

func (j JWTPayload) GetAudience() (jwt.ClaimStrings, error)

func (JWTPayload) GetExpirationTime

func (j JWTPayload) GetExpirationTime() (*jwt.NumericDate, error)

func (JWTPayload) GetIssuedAt

func (j JWTPayload) GetIssuedAt() (*jwt.NumericDate, error)

func (JWTPayload) GetIssuer

func (j JWTPayload) GetIssuer() (string, error)

func (JWTPayload) GetNotBefore

func (j JWTPayload) GetNotBefore() (*jwt.NumericDate, error)

func (JWTPayload) GetSubject

func (j JWTPayload) GetSubject() (string, error)

type PasetoMaker

type PasetoMaker[P TokenPayload] struct {
	// contains filtered or unexported fields
}

func (PasetoMaker[P]) CreateToken

func (p PasetoMaker[P]) CreateToken(payload P, tokenType TokenType) (string, P, error)

func (PasetoMaker[P]) Middleware

func (p PasetoMaker[P]) Middleware(store *sessions.CookieStore, sessionName string, tokenType TokenType) func(http.Handler) http.Handler

func (PasetoMaker[P]) TokenFromRequest

func (p PasetoMaker[P]) TokenFromRequest(request *http.Request, tokenType TokenType) (P, error)

func (PasetoMaker[P]) VerifyToken

func (p PasetoMaker[P]) VerifyToken(s string, tokenType TokenType) (P, error)

type TokenMaker

type TokenMaker[P TokenPayload] interface {
	CreateToken(P, TokenType) (string, P, error)
	VerifyToken(string, TokenType) (P, error)
	Middleware(*sessions.CookieStore, string, TokenType) func(http.Handler) http.Handler
	TokenFromRequest(*http.Request, TokenType) (P, error)
}

func NewJWTMaker

func NewJWTMaker[P TokenPayload](durations map[TokenType]time.Duration, errInvalidToken, errExpiredToken, errInvalidCookie error, secret string) TokenMaker[P]

func NewPasetoMaker

func NewPasetoMaker[P TokenPayload](durations map[TokenType]time.Duration, errInvalidToken, errExpiredToken, errInvalidCookie error) TokenMaker[P]

type TokenPayload

type TokenPayload interface {
	GetIssuedAt() time.Time
	GetExpiresAt() time.Time
	GetType() TokenType
	SetIssuedAt(time.Time)
	SetExpiresAt(time.Time)
	SetType(TokenType)
}

type TokenType

type TokenType int