Documentation
¶
Overview ¶
Package http implements helpers for HTTP requests.
Index ¶
Constants ¶
View Source
const JSONContentType = "application/json"
JSONContentType represents MIME type for JSON content.
Variables ¶
View Source
var DefaultHealthPath = "/health"
DefaultHealthPath is the default HTTP path for checking health.
Functions ¶
func JSON ¶
func JSON(w http.ResponseWriter, code int, v interface{}) error
JSON encodes json content to the ResponseWriter.
func NewHealthHandler ¶
func NewHealthHandler(v ...Health) http.HandlerFunc
NewHealthHandler returns a handler for application health checking.
func OK ¶ added in v2.3.0
func OK(rw http.ResponseWriter, _ *http.Request)
OK replies to the request with an HTTP 200 ok reply.
Types ¶
type Health ¶
type Health interface {
IsHealthy() error
}
Health represents an object that can check its health.
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
Server is a convenience wrapper around the standard library HTTP server.
type SrvOptFunc ¶
SrvOptFunc represents a server option function.
func WithH2C ¶ added in v2.2.0
func WithH2C() SrvOptFunc
WithH2C allows the server to handle h2c connections.
func WithReadTimeout ¶ added in v2.2.2
func WithReadTimeout(d time.Duration) SrvOptFunc
WithReadTimeout sets the server read timeout.
func WithTLSConfig ¶
func WithTLSConfig(cfg *tls.Config) SrvOptFunc
WithTLSConfig sets the serve tls config.
func WithWriteTimeout ¶ added in v2.2.2
func WithWriteTimeout(d time.Duration) SrvOptFunc
WithWriteTimeout sets the server write timeout.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package middleware implements reusable HTTP middleware.
|
Package middleware implements reusable HTTP middleware. |
Click to show internal directories.
Click to hide internal directories.