http

Documentation

Overview

Package http provides a set of utilities for handling HTTP requests and responses within the GoFr framework.

Index

• Constants
• type ErrorEntityAlreadyExist
  • func (ErrorEntityAlreadyExist) Error() string
  • func (ErrorEntityAlreadyExist) StatusCode() int
• type ErrorEntityNotFound
  • func (e ErrorEntityNotFound) Error() string
  • func (ErrorEntityNotFound) StatusCode() int
• type ErrorInvalidParam
  • func (e ErrorInvalidParam) Error() string
  • func (ErrorInvalidParam) StatusCode() int
• type ErrorInvalidRoute
  • func (ErrorInvalidRoute) Error() string
  • func (ErrorInvalidRoute) StatusCode() int
• type ErrorMissingParam
  • func (e ErrorMissingParam) Error() string
  • func (ErrorMissingParam) StatusCode() int
• type ErrorPanicRecovery
  • func (ErrorPanicRecovery) Error() string
  • func (ErrorPanicRecovery) StatusCode() int
• type ErrorRequestTimeout
  • func (ErrorRequestTimeout) Error() string
  • func (ErrorRequestTimeout) StatusCode() int
• type Metrics
• type Middleware
• type Request
  • func NewRequest(r *http.Request) *Request
  • func (r *Request) Bind(i interface{}) error
  • func (r *Request) Context() context.Context
  • func (r *Request) HostName() string
  • func (r *Request) Param(key string) string
  • func (r *Request) Params(key string) []string
  • func (r *Request) PathParam(key string) string
• type Responder
  • func NewResponder(w http.ResponseWriter, method string) *Responder
  • func (r Responder) Respond(data interface{}, err error)
• type Router
  • func NewRouter() *Router
  • func (rou *Router) Add(method, pattern string, handler http.Handler)
  • func (rou *Router) AddStaticFiles(endpoint, dirName string)
  • func (rou *Router) UseMiddleware(mws ...Middleware)

Constants

const DefaultSwaggerFileName = "openapi.json"

Types

type ErrorEntityAlreadyExist

type ErrorEntityAlreadyExist struct {
}

ErrorEntityAlreadyExist represents an error for when entity is already present in the storage and we are trying to make duplicate entry.

func (ErrorEntityAlreadyExist) Error

func (ErrorEntityAlreadyExist) Error() string

func (ErrorEntityAlreadyExist) StatusCode

func (ErrorEntityAlreadyExist) StatusCode() int

type ErrorEntityNotFound

type ErrorEntityNotFound struct {
	Name  string
	Value string
}

ErrorEntityNotFound represents an error for when an entity is not found in the system.

func (ErrorEntityNotFound) Error

func (e ErrorEntityNotFound) Error() string

func (ErrorEntityNotFound) StatusCode

func (ErrorEntityNotFound) StatusCode() int

type ErrorInvalidParam

type ErrorInvalidParam struct {
	Params []string `json:"param,omitempty"` // Params contains the list of invalid parameter names.
}

ErrorInvalidParam represents an error for invalid parameter values.

func (ErrorInvalidParam) Error

func (e ErrorInvalidParam) Error() string

func (ErrorInvalidParam) StatusCode

func (ErrorInvalidParam) StatusCode() int

type ErrorInvalidRoute

type ErrorInvalidRoute struct{}

ErrorInvalidRoute represents an error for invalid route in a request.

func (ErrorInvalidRoute) Error

func (ErrorInvalidRoute) Error() string

func (ErrorInvalidRoute) StatusCode

func (ErrorInvalidRoute) StatusCode() int

type ErrorMissingParam

type ErrorMissingParam struct {
	Params []string `json:"param,omitempty"`
}

ErrorMissingParam represents an error for missing parameters in a request.

func (ErrorMissingParam) Error

func (e ErrorMissingParam) Error() string

func (ErrorMissingParam) StatusCode

func (ErrorMissingParam) StatusCode() int

type ErrorPanicRecovery

type ErrorPanicRecovery struct{}

ErrorPanicRecovery represents an error for request which panicked.

func (ErrorPanicRecovery) Error

func (ErrorPanicRecovery) Error() string

func (ErrorPanicRecovery) StatusCode

func (ErrorPanicRecovery) StatusCode() int

type ErrorRequestTimeout

type ErrorRequestTimeout struct{}

ErrorRequestTimeout represents an error for request which timed out.

func (ErrorRequestTimeout) Error

func (ErrorRequestTimeout) Error() string

func (ErrorRequestTimeout) StatusCode

func (ErrorRequestTimeout) StatusCode() int

type Metrics

type Metrics interface {
	IncrementCounter(ctx context.Context, name string, labels ...string)
}

Metrics represents an interface for registering the default metrics in GoFr framework.

type Middleware

type Middleware func(handler http.Handler) http.Handler

type Request

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

Request is an abstraction over the underlying http.Request. This abstraction is useful because it allows us to create applications without being aware of the transport. cmd.Request is another such abstraction.

func NewRequest

func NewRequest(r *http.Request) *Request

NewRequest creates a new GoFr Request instance from the given http.Request.

func (*Request) Bind

func (r *Request) Bind(i interface{}) error

Bind parses the request body and binds it to the provided interface.

func (*Request) Context

func (r *Request) Context() context.Context

Context returns the context of the request.

func (*Request) HostName

func (r *Request) HostName() string

HostName retrieves the hostname from the request.

func (*Request) Param

func (r *Request) Param(key string) string

Param returns the query parameter with the given key.

func (*Request) Params

func (r *Request) Params(key string) []string

Params returns a slice of strings containing the values associated with the given query parameter key. If the parameter is not present, an empty slice is returned.

func (*Request) PathParam

func (r *Request) PathParam(key string) string

PathParam retrieves a path parameter from the request.

type Responder

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

Responder encapsulates an http.ResponseWriter and is responsible for crafting structured responses.

func NewResponder

func NewResponder(w http.ResponseWriter, method string) *Responder

NewResponder creates a new Responder instance from the given http.ResponseWriter..

func (Responder) Respond

func (r Responder) Respond(data interface{}, err error)

Respond sends a response with the given data and handles potential errors, setting appropriate status codes and formatting responses as JSON or raw data as needed.

type Router

type Router struct {
	mux.Router
	RegisteredRoutes *[]string
}

Router is responsible for routing HTTP request.

func NewRouter

func NewRouter() *Router

NewRouter creates a new Router instance.

func (*Router) Add

func (rou *Router) Add(method, pattern string, handler http.Handler)

Add adds a new route with the given HTTP method, pattern, and handler, wrapping the handler with OpenTelemetry instrumentation.

func (*Router) AddStaticFiles

func (rou *Router) AddStaticFiles(endpoint, dirName string)

func (*Router) UseMiddleware

func (rou *Router) UseMiddleware(mws ...Middleware)

UseMiddleware registers middlewares to the router.