httpServerModel

Documentation

Index

• Constants
• type CORS
  • func NewCORS() *CORS
  • func (c *CORS) AddHeader(header ...string)
  • func (c *CORS) AddOrigin(origin ...string)
  • func (c *CORS) AllowedHeaders() []string
  • func (c *CORS) AllowedOrigins() []string
• type Config
  • func NewDefaultConfig(port int) *Config
  • func (c *Config) IsContainMiddlewares() bool
  • func (c *Config) Middlewares() []func(http.Handler) http.Handler
  • func (c *Config) Port() int
  • func (c *Config) PrivateHandlers() []*RequestHandler
  • func (c *Config) PublicHandlers() []*RequestHandler
  • func (c *Config) RegisterMiddleware(middleware func(http.Handler) http.Handler)
  • func (c *Config) RegisterPrivateHandler(method, route string, handlerFn http.HandlerFunc)
  • func (c *Config) RegisterPublicHandler(method, route string, handlerFn http.HandlerFunc)
• type ErrorResponse
  • func NewErrorResponse(errorsData []ErrorResponseData) ErrorResponse
  • func NewSingleErrorResponse(errorData ErrorResponseData) ErrorResponse
  • func (r ErrorResponse) FirstHttpCode() int
• type ErrorResponseData
• type RequestHandler
  • func (h *RequestHandler) HandlerFunc() http.HandlerFunc
  • func (h *RequestHandler) Method() string
  • func (h *RequestHandler) Route() string

Constants

const (
	RequestIDHeaderName       = "X-Request-ID"
	HeaderContentType         = "Content-Type"
	HeaderContentLength       = "Content-Length"
	HeaderXContentTypeOptions = "X-Content-Type-Options"
)

const (
	ReadyURL  = "/readyz"
	HealthURL = "/healthz"
)

Types

type CORS

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

func NewCORS

func NewCORS() *CORS

func (*CORS) AddHeader

func (c *CORS) AddHeader(header ...string)

func (*CORS) AddOrigin

func (c *CORS) AddOrigin(origin ...string)

func (*CORS) AllowedHeaders

func (c *CORS) AllowedHeaders() []string

func (*CORS) AllowedOrigins

func (c *CORS) AllowedOrigins() []string

type Config

type Config struct {
	ReadTimeout     int
	WriteTimeout    int
	IdleTimeOut     int
	ShutdownTimeout int

	CORS *CORS
	// contains filtered or unexported fields
}

func NewDefaultConfig

func NewDefaultConfig(port int) *Config

func (*Config) IsContainMiddlewares

func (c *Config) IsContainMiddlewares() bool

func (*Config) Middlewares

func (c *Config) Middlewares() []func(http.Handler) http.Handler

func (*Config) Port

func (c *Config) Port() int

func (*Config) PrivateHandlers

func (c *Config) PrivateHandlers() []*RequestHandler

func (*Config) PublicHandlers

func (c *Config) PublicHandlers() []*RequestHandler

func (*Config) RegisterMiddleware

func (c *Config) RegisterMiddleware(middleware func(http.Handler) http.Handler)

func (*Config) RegisterPrivateHandler

func (c *Config) RegisterPrivateHandler(method, route string, handlerFn http.HandlerFunc)

func (*Config) RegisterPublicHandler

func (c *Config) RegisterPublicHandler(method, route string, handlerFn http.HandlerFunc)

type ErrorResponse

type ErrorResponse struct {
	Errors []ErrorResponseData `json:"errors"`
}

func NewErrorResponse

func NewErrorResponse(errorsData []ErrorResponseData) ErrorResponse

func NewSingleErrorResponse

func NewSingleErrorResponse(errorData ErrorResponseData) ErrorResponse

func (ErrorResponse) FirstHttpCode

func (r ErrorResponse) FirstHttpCode() int

type ErrorResponseData

type ErrorResponseData struct {
	HttpCode  int    `json:"responseCode"`
	ErrorCode string `json:"errorCode"`
	Text      string `json:"text"`
}

type RequestHandler

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

func (*RequestHandler) HandlerFunc

func (h *RequestHandler) HandlerFunc() http.HandlerFunc

func (*RequestHandler) Method

func (h *RequestHandler) Method() string

func (*RequestHandler) Route

func (h *RequestHandler) Route() string