http

package

v2.1.0 Latest Latest Go to latest Published: Jul 24, 2021 License: MIT Imports: 8 Imported by: 2

Details

Package http implements helpers for HTTP requests.

View Source

const JSONContentType = "application/json"

JSONContentType represents MIME type for JSON content.

View Source

var DefaultHealthPath = "/health"

DefaultHealthPath is the default HTTP path for checking health.

func JSON(w http.ResponseWriter, code int, v interface{}) error

JSON encodes json content to the ResponseWriter.

func NewHealthHandler(v ...Health) http.HandlerFunc

NewHealthHandler returns a handler for application health checking.

func RealIP(r *http.Request) string

RealIP resolves the real client IP address from the request.

type Health interface {
	IsHealthy() error
}

Health represents an object that can check its health.

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

Server is a convenience wrapper around the standard library http server.

func NewServer(ctx context.Context, addr string, h http.Handler, opts ...SrvOptFunc) *Server

NewServer returns a server.

func (s *Server) Close() error

Close closes the server.

func (s *Server) Serve(errFn func(error))

Serve starts the server in a in-blocking way.

func (s *Server) Shutdown(timeout time.Duration) error

Shutdown attempts to close all server connections.

type SrvOptFunc func(*http.Server)

SrvOptFunc represents a server option function.

func WithTLSConfig(cfg *tls.Config) SrvOptFunc

WithTLSConfig sets the serve tls config.

Path	Synopsis
middleware Package middleware implements reusable HTTP middleware.	Package middleware implements reusable HTTP middleware.