server

Documentation

Index

• func EncodeMetaError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, ...) func(context.Context, http.ResponseWriter, error) error
• func EncodeMetaResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, interface{}) error
• func MetaModulesPath() string
• func Mount(mux goahttp.Muxer, h *Server)
• func MountCORSHandler(mux goahttp.Muxer, h http.Handler)
• func MountMetaHandler(mux goahttp.Muxer, h http.Handler)
• func NewCORSHandler() http.Handler
• func NewMetaHandler(endpoint goa.Endpoint, mux goahttp.Muxer, ...) http.Handler
• type ErrorNamer
• type MetaBadRequestResponseBody
  • func NewMetaBadRequestResponseBody(res *goa.ServiceError) *MetaBadRequestResponseBody
• type MetaForbiddenResponseBody
  • func NewMetaForbiddenResponseBody(res *goa.ServiceError) *MetaForbiddenResponseBody
• type MetaNotFoundResponseBody
  • func NewMetaNotFoundResponseBody(res *goa.ServiceError) *MetaNotFoundResponseBody
• type MetaUnauthorizedResponseBody
  • func NewMetaUnauthorizedResponseBody(res *goa.ServiceError) *MetaUnauthorizedResponseBody
• type MountPoint
• type Server
  • func New(e *modules.Endpoints, mux goahttp.Muxer, ...) *Server
  • func (s *Server) Service() string
  • func (s *Server) Use(m func(http.Handler) http.Handler)

Functions

func EncodeMetaError

func EncodeMetaError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeMetaError returns an encoder for errors returned by the meta modules endpoint.

func EncodeMetaResponse

func EncodeMetaResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, interface{}) error

EncodeMetaResponse returns an encoder for responses returned by the modules meta endpoint.

func MetaModulesPath

func MetaModulesPath() string

MetaModulesPath returns the URL path to the modules service meta HTTP endpoint.

func Mount

func Mount(mux goahttp.Muxer, h *Server)

Mount configures the mux to serve the modules endpoints.

func MountCORSHandler

func MountCORSHandler(mux goahttp.Muxer, h http.Handler)

MountCORSHandler configures the mux to serve the CORS endpoints for the service modules.

func MountMetaHandler

func MountMetaHandler(mux goahttp.Muxer, h http.Handler)

MountMetaHandler configures the mux to serve the "modules" service "meta" endpoint.

func NewCORSHandler

func NewCORSHandler() http.Handler

NewCORSHandler creates a HTTP handler which returns a simple 200 response.

func NewMetaHandler

func NewMetaHandler(
	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

NewMetaHandler creates a HTTP handler which loads the HTTP request and calls the "modules" service "meta" 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 MetaBadRequestResponseBody

type MetaBadRequestResponseBody 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"`
}

MetaBadRequestResponseBody is the type of the "modules" service "meta" endpoint HTTP response body for the "bad-request" error.

func NewMetaBadRequestResponseBody

func NewMetaBadRequestResponseBody(res *goa.ServiceError) *MetaBadRequestResponseBody

NewMetaBadRequestResponseBody builds the HTTP response body from the result of the "meta" endpoint of the "modules" service.

type MetaForbiddenResponseBody

type MetaForbiddenResponseBody 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"`
}

MetaForbiddenResponseBody is the type of the "modules" service "meta" endpoint HTTP response body for the "forbidden" error.

func NewMetaForbiddenResponseBody

func NewMetaForbiddenResponseBody(res *goa.ServiceError) *MetaForbiddenResponseBody

NewMetaForbiddenResponseBody builds the HTTP response body from the result of the "meta" endpoint of the "modules" service.

type MetaNotFoundResponseBody

type MetaNotFoundResponseBody 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"`
}

MetaNotFoundResponseBody is the type of the "modules" service "meta" endpoint HTTP response body for the "not-found" error.

func NewMetaNotFoundResponseBody

func NewMetaNotFoundResponseBody(res *goa.ServiceError) *MetaNotFoundResponseBody

NewMetaNotFoundResponseBody builds the HTTP response body from the result of the "meta" endpoint of the "modules" service.

type MetaUnauthorizedResponseBody

type MetaUnauthorizedResponseBody 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"`
}

MetaUnauthorizedResponseBody is the type of the "modules" service "meta" endpoint HTTP response body for the "unauthorized" error.

func NewMetaUnauthorizedResponseBody

func NewMetaUnauthorizedResponseBody(res *goa.ServiceError) *MetaUnauthorizedResponseBody

NewMetaUnauthorizedResponseBody builds the HTTP response body from the result of the "meta" endpoint of the "modules" 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
	Meta   http.Handler
	CORS   http.Handler
}

Server lists the modules service endpoint HTTP handlers.

func New

func New(
	e *modules.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 modules 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) Service

func (s *Server) Service() string

Service returns the name of the service served.

func (*Server) Use

func (s *Server) Use(m func(http.Handler) http.Handler)

Use wraps the server handlers with the given middleware.