server

Documentation

Index

• func EncodeFiveError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, ...) func(context.Context, http.ResponseWriter, error) error
• func EncodeFiveResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, interface{}) error
• func FiveTasksPath() string
• func Mount(mux goahttp.Muxer, h *Server)
• func MountCORSHandler(mux goahttp.Muxer, h http.Handler)
• func MountFiveHandler(mux goahttp.Muxer, h http.Handler)
• func NewCORSHandler() http.Handler
• func NewFiveHandler(endpoint goa.Endpoint, mux goahttp.Muxer, ...) http.Handler
• type ErrorNamer
• type FiveBadRequestResponseBody
  • func NewFiveBadRequestResponseBody(res *goa.ServiceError) *FiveBadRequestResponseBody
• type FiveForbiddenResponseBody
  • func NewFiveForbiddenResponseBody(res *goa.ServiceError) *FiveForbiddenResponseBody
• type FiveNotFoundResponseBody
  • func NewFiveNotFoundResponseBody(res *goa.ServiceError) *FiveNotFoundResponseBody
• type FiveUnauthorizedResponseBody
  • func NewFiveUnauthorizedResponseBody(res tasks.Unauthorized) FiveUnauthorizedResponseBody
• type MountPoint
• type Server
  • func New(e *tasks.Endpoints, mux goahttp.Muxer, ...) *Server
  • func (s *Server) Service() string
  • func (s *Server) Use(m func(http.Handler) http.Handler)

Functions

func EncodeFiveError

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

EncodeFiveError returns an encoder for errors returned by the five tasks endpoint.

func EncodeFiveResponse

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

EncodeFiveResponse returns an encoder for responses returned by the tasks five endpoint.

func FiveTasksPath

func FiveTasksPath() string

FiveTasksPath returns the URL path to the tasks service five HTTP endpoint.

func Mount

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

Mount configures the mux to serve the tasks endpoints.

func MountCORSHandler

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

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

func MountFiveHandler

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

MountFiveHandler configures the mux to serve the "tasks" service "five" endpoint.

func NewCORSHandler

func NewCORSHandler() http.Handler

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

func NewFiveHandler

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

NewFiveHandler creates a HTTP handler which loads the HTTP request and calls the "tasks" service "five" 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 FiveBadRequestResponseBody

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

FiveBadRequestResponseBody is the type of the "tasks" service "five" endpoint HTTP response body for the "bad-request" error.

func NewFiveBadRequestResponseBody

func NewFiveBadRequestResponseBody(res *goa.ServiceError) *FiveBadRequestResponseBody

NewFiveBadRequestResponseBody builds the HTTP response body from the result of the "five" endpoint of the "tasks" service.

type FiveForbiddenResponseBody

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

FiveForbiddenResponseBody is the type of the "tasks" service "five" endpoint HTTP response body for the "forbidden" error.

func NewFiveForbiddenResponseBody

func NewFiveForbiddenResponseBody(res *goa.ServiceError) *FiveForbiddenResponseBody

NewFiveForbiddenResponseBody builds the HTTP response body from the result of the "five" endpoint of the "tasks" service.

type FiveNotFoundResponseBody

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

FiveNotFoundResponseBody is the type of the "tasks" service "five" endpoint HTTP response body for the "not-found" error.

func NewFiveNotFoundResponseBody

func NewFiveNotFoundResponseBody(res *goa.ServiceError) *FiveNotFoundResponseBody

NewFiveNotFoundResponseBody builds the HTTP response body from the result of the "five" endpoint of the "tasks" service.

type FiveUnauthorizedResponseBody

type FiveUnauthorizedResponseBody string

FiveUnauthorizedResponseBody is the type of the "tasks" service "five" endpoint HTTP response body for the "unauthorized" error.

func NewFiveUnauthorizedResponseBody

func NewFiveUnauthorizedResponseBody(res tasks.Unauthorized) FiveUnauthorizedResponseBody

NewFiveUnauthorizedResponseBody builds the HTTP response body from the result of the "five" endpoint of the "tasks" 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
	Five   http.Handler
	CORS   http.Handler
}

Server lists the tasks service endpoint HTTP handlers.

func New

func New(
	e *tasks.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 tasks 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.