Documentation
¶
Index ¶
- func EncodeGetStatusError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, ...) func(context.Context, http.ResponseWriter, error) error
- func EncodeGetStatusResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, interface{}) error
- func GetStatusHealthPath() string
- func HandleHealthOrigin(h http.Handler) http.Handler
- func Mount(mux goahttp.Muxer, h *Server)
- func MountCORSHandler(mux goahttp.Muxer, h http.Handler)
- func MountGetStatusHandler(mux goahttp.Muxer, h http.Handler)
- func NewCORSHandler() http.Handler
- func NewGetStatusHandler(endpoint goa.Endpoint, mux goahttp.Muxer, ...) http.Handler
- type ErrorNamer
- type GetStatusInternalResponseBody
- type GetStatusResponseBody
- type HealthStatusResponseBody
- type MountPoint
- type Server
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func EncodeGetStatusError ¶
func EncodeGetStatusError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error
EncodeGetStatusError returns an encoder for errors returned by the GetStatus health endpoint.
func EncodeGetStatusResponse ¶
func EncodeGetStatusResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, interface{}) error
EncodeGetStatusResponse returns an encoder for responses returned by the health GetStatus endpoint.
func GetStatusHealthPath ¶
func GetStatusHealthPath() string
GetStatusHealthPath returns the URL path to the health service GetStatus HTTP endpoint.
func HandleHealthOrigin ¶
HandleHealthOrigin applies the CORS response headers corresponding to the origin for the service health.
func MountCORSHandler ¶
MountCORSHandler configures the mux to serve the CORS endpoints for the service health.
func MountGetStatusHandler ¶
MountGetStatusHandler configures the mux to serve the "health" service "GetStatus" endpoint.
func NewCORSHandler ¶
NewCORSHandler creates a HTTP handler which returns a simple 200 response.
func NewGetStatusHandler ¶
func NewGetStatusHandler( 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(err error) goahttp.Statuser, ) http.Handler
NewGetStatusHandler creates a HTTP handler which loads the HTTP request and calls the "health" service "GetStatus" endpoint.
Types ¶
type ErrorNamer ¶
type ErrorNamer interface {
ErrorName() string
}
ErrorNamer is an interface implemented by generated error structs that exposes the name of the error as defined in the design.
type GetStatusInternalResponseBody ¶
type GetStatusInternalResponseBody struct {
// Name is the name of this class of errors.
Name string `form:"name" json:"name" xml:"name"`
// ID is a unique identifier for this particular occurrence of the problem.
ID string `form:"id" json:"id" xml:"id"`
// Message is a human-readable explanation specific to this occurrence of the
// problem.
Message string `form:"message" json:"message" xml:"message"`
// Is the error temporary?
Temporary bool `form:"temporary" json:"temporary" xml:"temporary"`
// Is the error a timeout?
Timeout bool `form:"timeout" json:"timeout" xml:"timeout"`
// Is the error a server-side fault?
Fault bool `form:"fault" json:"fault" xml:"fault"`
}
GetStatusInternalResponseBody is the type of the "health" service "GetStatus" endpoint HTTP response body for the "internal" error.
func NewGetStatusInternalResponseBody ¶
func NewGetStatusInternalResponseBody(res *goa.ServiceError) *GetStatusInternalResponseBody
NewGetStatusInternalResponseBody builds the HTTP response body from the result of the "GetStatus" endpoint of the "health" service.
type GetStatusResponseBody ¶
type GetStatusResponseBody struct {
// Status of the response.
S string `form:"s" json:"s" xml:"s"`
// Error message.
Errmsg *string `form:"errmsg,omitempty" json:"errmsg,omitempty" xml:"errmsg,omitempty"`
Data *HealthStatusResponseBody `form:"data,omitempty" json:"data,omitempty" xml:"data,omitempty"`
Status string `form:"status" json:"status" xml:"status"`
}
GetStatusResponseBody is the type of the "health" service "GetStatus" endpoint HTTP response body.
func NewGetStatusResponseBody ¶
func NewGetStatusResponseBody(res *health.HealthStatusResponse) *GetStatusResponseBody
NewGetStatusResponseBody builds the HTTP response body from the result of the "GetStatus" endpoint of the "health" service.
type HealthStatusResponseBody ¶
type HealthStatusResponseBody struct {
}
HealthStatusResponseBody is used to define fields on response body types.
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
GetStatus http.Handler
CORS 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(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.
Source Files