qrouter

README

#qrouter

Documentation

Index

• func Adapt(h http.Handler, adapters ...Adapter) http.Handler
• func BindJSON(w http.ResponseWriter, r *http.Request, dest interface{}) error
• func DeleteCookie(writer http.ResponseWriter, request *http.Request, name string) (string, error)
• func GetCookie(writer http.ResponseWriter, request *http.Request, name string) (string, error)
• func GetImage(w http.ResponseWriter, r *http.Request, i *Imager)
• func ReadFile(fileHeader *multipart.FileHeader, ir MultipartReader, MaxSize int64, ...) error
• func RedirectJSONResponse(writer http.ResponseWriter, request *http.Request, url string, v any)
• func RequestLogger(next http.Handler) http.Handler
• func SetRecaptchaKey(key string)
• func WriteBytesResponse(w http.ResponseWriter, v []byte)
• func WriteJSONError(writer http.ResponseWriter, text string, code int)
• func WriteJSONResponse(w http.ResponseWriter, v any)
• func WriteMultipartResponse(w http.ResponseWriter, v map[string][]byte)
• type Adapter
• type Endpoint
  • func InitApi(mux *http.ServeMux, path string, middleware ...Adapter) *Endpoint
  • func (e *Endpoint) Group(path string, middleware ...Adapter) *Endpoint
  • func (e *Endpoint) Handle(h ...PathHandler)
• type Imager
• type MultipartReader
• type PathHandler
  • func (ph PathHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type ReCaptcher
• type RecaptchaResponse
  • func VerifyReCaptcha(recaptcha string) (RecaptchaResponse, error)

Functions

func Adapt

func Adapt(h http.Handler, adapters ...Adapter) http.Handler

func BindJSON

func BindJSON(w http.ResponseWriter, r *http.Request, dest interface{}) error

func DeleteCookie

func DeleteCookie(writer http.ResponseWriter, request *http.Request, name string) (string, error)

DeleteCookie receives cookie from gin.Context, deletes this cookie from gin.Context and returns its value or error.

func GetCookie

func GetCookie(writer http.ResponseWriter, request *http.Request, name string) (string, error)

GetCookie receives cookie from gin.Context or raise http.StatusForbidden error, returns cookie or error

func GetImage

func GetImage(w http.ResponseWriter, r *http.Request, i *Imager)

func ReadFile

func ReadFile(fileHeader *multipart.FileHeader, ir MultipartReader, MaxSize int64, allowedFileTypes []string) error

func RedirectJSONResponse

func RedirectJSONResponse(writer http.ResponseWriter, request *http.Request, url string, v any)

func RequestLogger

func RequestLogger(next http.Handler) http.Handler

func SetRecaptchaKey

func SetRecaptchaKey(key string)

SetRecaptchaKey is function that set recaptcha secret key

func WriteBytesResponse

func WriteBytesResponse(w http.ResponseWriter, v []byte)

func WriteJSONError

func WriteJSONError(writer http.ResponseWriter, text string, code int)

func WriteJSONResponse

func WriteJSONResponse(w http.ResponseWriter, v any)

func WriteMultipartResponse

func WriteMultipartResponse(w http.ResponseWriter, v map[string][]byte)

Types

type Adapter

type Adapter func(http.Handler) http.Handler

type Endpoint

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

func InitApi

func InitApi(mux *http.ServeMux, path string, middleware ...Adapter) *Endpoint

func (*Endpoint) Group

func (e *Endpoint) Group(path string, middleware ...Adapter) *Endpoint

func (*Endpoint) Handle

func (e *Endpoint) Handle(h ...PathHandler)

type Imager

type Imager interface {
	SetName(name string)
	ReadRawByName(ctx context.Context) error
	GetRaw() []byte
}

type MultipartReader

type MultipartReader interface {
	ReadFromMultipart(fileHeader *multipart.FileHeader, allowedFileTypes []string) error
}

type PathHandler

type PathHandler struct {
	Path                          string
	GET, POST, PUT, PATCH, DELETE http.HandlerFunc
}

func (PathHandler) ServeHTTP

func (ph PathHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type ReCaptcher

type ReCaptcher interface {
	GetReCaptcha() string
}

type RecaptchaResponse

type RecaptchaResponse struct {
	Success     bool      `json:"success"`
	Score       float64   `json:"score"`
	Action      string    `json:"action"`
	ChallengeTS time.Time `json:"challenge_ts"`
	Hostname    string    `json:"hostname"`
	ErrorCodes  []string  `json:"error-codes"`
}

RecaptchaResponse is struct that contains recaptcha validating response fields

func VerifyReCaptcha

func VerifyReCaptcha(recaptcha string) (RecaptchaResponse, error)

VerifyReCaptcha is ...