Documentation
¶
Index ¶
- func EncodeStatusResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error
- func HandleStatusOrigin(h http.Handler) http.Handler
- func Mount(mux goahttp.Muxer, h *Server)
- func MountCORSHandler(mux goahttp.Muxer, h http.Handler)
- func MountStatusHandler(mux goahttp.Muxer, h http.Handler)
- func NewCORSHandler() http.Handler
- func NewStatusHandler(endpoint goa.Endpoint, mux goahttp.Muxer, ...) http.Handler
- func StatusStatusPath() string
- func StatusStatusPath2() string
- type HubServiceResponseBody
- type MountPoint
- type Server
- type StatusResponseBody
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func EncodeStatusResponse ¶
func EncodeStatusResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error
EncodeStatusResponse returns an encoder for responses returned by the status Status endpoint.
func HandleStatusOrigin ¶ added in v1.8.0
HandleStatusOrigin applies the CORS response headers corresponding to the origin for the service status.
func MountCORSHandler ¶
MountCORSHandler configures the mux to serve the CORS endpoints for the service status.
func MountStatusHandler ¶
MountStatusHandler configures the mux to serve the "status" service "Status" endpoint.
func NewCORSHandler ¶
NewCORSHandler creates a HTTP handler which returns a simple 204 response.
func NewStatusHandler ¶
func NewStatusHandler( 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
NewStatusHandler creates a HTTP handler which loads the HTTP request and calls the "status" service "Status" endpoint.
func StatusStatusPath ¶
func StatusStatusPath() string
StatusStatusPath returns the URL path to the status service Status HTTP endpoint.
func StatusStatusPath2 ¶
func StatusStatusPath2() string
StatusStatusPath2 returns the URL path to the status service Status HTTP endpoint.
Types ¶
type HubServiceResponseBody ¶
type HubServiceResponseBody struct {
// Name of the service
Name string `form:"name" json:"name" xml:"name"`
// Status of the service
Status string `form:"status" json:"status" xml:"status"`
// Details of the error if any
Error *string `form:"error,omitempty" json:"error,omitempty" xml:"error,omitempty"`
}
HubServiceResponseBody 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
Status http.Handler
CORS http.Handler
}
Server lists the status service endpoint HTTP handlers.
func New ¶
func New( e *status.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 status 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 ¶ added in v1.11.0
MethodNames returns the methods served.
type StatusResponseBody ¶
type StatusResponseBody struct {
// List of services and their status
Services []*HubServiceResponseBody `form:"services,omitempty" json:"services,omitempty" xml:"services,omitempty"`
}
StatusResponseBody is the type of the "status" service "Status" endpoint HTTP response body.
func NewStatusResponseBody ¶
func NewStatusResponseBody(res *status.StatusResult) *StatusResponseBody
NewStatusResponseBody builds the HTTP response body from the result of the "Status" endpoint of the "status" service.
Source Files