Documentation
¶
Index ¶
- func CheckHealthPath() string
- func EncodeCheckResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error
- func Mount(mux goahttp.Muxer, h *Server)
- func MountCheckHandler(mux goahttp.Muxer, h http.Handler)
- func NewCheckHandler(endpoint goa.Endpoint, mux goahttp.Muxer, ...) http.Handler
- type CheckResponseBody
- type MountPoint
- type Server
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckHealthPath ¶
func CheckHealthPath() string
CheckHealthPath returns the URL path to the health service check HTTP endpoint.
func EncodeCheckResponse ¶
func EncodeCheckResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error
EncodeCheckResponse returns an encoder for responses returned by the health check endpoint.
func MountCheckHandler ¶
MountCheckHandler configures the mux to serve the "health" service "check" endpoint.
func NewCheckHandler ¶
func NewCheckHandler( endpoint goa.Endpoint, mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder, encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, errhandler func(context.Context, http.ResponseWriter, error), formatter func(ctx context.Context, err error) goahttp.Statuser, ) http.Handler
NewCheckHandler creates a HTTP handler which loads the HTTP request and calls the "health" service "check" endpoint.
Types ¶
type CheckResponseBody ¶
type CheckResponseBody struct {
// Health status
Status string `form:"status" json:"status" xml:"status"`
}
CheckResponseBody is the type of the "health" service "check" endpoint HTTP response body.
func NewCheckResponseBody ¶
func NewCheckResponseBody(res *health.CheckResult) *CheckResponseBody
NewCheckResponseBody builds the HTTP response body from the result of the "check" endpoint of the "health" service.
type MountPoint ¶
type MountPoint struct {
// Method is the name of the service method served by the mounted HTTP handler.
Method string
// Verb is the HTTP method used to match requests to the mounted handler.
Verb string
// Pattern is the HTTP request path pattern used to match requests to the
// mounted handler.
Pattern string
}
MountPoint holds information about the mounted endpoints.
type Server ¶
type Server struct {
Mounts []*MountPoint
Check http.Handler
}
Server lists the health service endpoint HTTP handlers.
func New ¶
func New( e *health.Endpoints, mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder, encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, errhandler func(context.Context, http.ResponseWriter, error), formatter func(ctx context.Context, err error) goahttp.Statuser, ) *Server
New instantiates HTTP handlers for all the health service endpoints using the provided encoder and decoder. The handlers are mounted on the given mux using the HTTP verb and path defined in the design. errhandler is called whenever a response fails to be encoded. formatter is used to format errors returned by the service methods prior to encoding. Both errhandler and formatter are optional and can be nil.
func (*Server) MethodNames ¶
MethodNames returns the methods served.
Source Files