httputil

Documentation

Index

• Constants
• func JSON(w http.ResponseWriter, status int, data interface{}) error
• func NewHandler(handler Handler) http.HandlerFunc
• func NoContent(w http.ResponseWriter) error
• func RunServer(ctx context.Context, options ServerOptions) error
• func String(w http.ResponseWriter, status int, data string) error
• type Error
  • func NewValidationErrors(field string, errors []string) (result []Error)
  • func (e Error) Error() string
• type Handler
• type Response
  • func (r Response) Error() string
• type ServerOptions

Constants

const (
	DefaultShutdownTimeout = time.Second * 5
)

Functions

func JSON

func JSON(w http.ResponseWriter, status int, data interface{}) error

func NewHandler

func NewHandler(handler Handler) http.HandlerFunc

func NoContent

func NoContent(w http.ResponseWriter) error

func RunServer

func RunServer(ctx context.Context, options ServerOptions) error

func String

func String(w http.ResponseWriter, status int, data string) error

Types

type Error

type Error struct {
	Type        string `json:"type,omitempty"`
	Description string `json:"description"`
	Field       string `json:"field,omitempty"`
}

func NewValidationErrors

func NewValidationErrors(field string, errors []string) (result []Error)

func (Error) Error

func (e Error) Error() string

type Handler

type Handler func(w http.ResponseWriter, r *http.Request) error

type Response

type Response struct {
	StatusCode int     `json:"-"`
	Errors     []Error `json:"errors,omitempty"`
}

func (Response) Error

func (r Response) Error() string

type ServerOptions

type ServerOptions struct {
	Name            string
	Address         string
	Handler         http.Handler
	ShutdownTimeout time.Duration
	Logger          logr.Logger
}