server

Documentation

Index

• func DecodeSayHelloRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (interface{}, error)
• func EncodeSayHelloResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, interface{}) error
• func Mount(mux goahttp.Muxer, h *Server)
• func MountGenHTTPOpenapiJSON(mux goahttp.Muxer, h http.Handler)
• func MountSayHelloHandler(mux goahttp.Muxer, h http.Handler)
• func NewSayHelloHandler(endpoint goa.Endpoint, mux goahttp.Muxer, ...) http.Handler
• func NewSayHelloPayload(name string) *hello.SayHelloPayload
• func SayHelloHelloPath(name string) string
• type ErrorNamer
• type MountPoint
• type Server
  • func New(e *hello.Endpoints, mux goahttp.Muxer, ...) *Server
  • func (s *Server) Mount(mux goahttp.Muxer)
  • func (s *Server) Service() string
  • func (s *Server) Use(m func(http.Handler) http.Handler)

Functions

func DecodeSayHelloRequest

func DecodeSayHelloRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (interface{}, error)

DecodeSayHelloRequest returns a decoder for requests sent to the hello say-hello endpoint.

func EncodeSayHelloResponse

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

EncodeSayHelloResponse returns an encoder for responses returned by the hello say-hello endpoint.

func Mount

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

Mount configures the mux to serve the hello endpoints.

func MountGenHTTPOpenapiJSON

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

MountGenHTTPOpenapiJSON configures the mux to serve GET request made to "/openapi.json".

func MountSayHelloHandler

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

MountSayHelloHandler configures the mux to serve the "hello" service "say-hello" endpoint.

func NewSayHelloHandler

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

NewSayHelloHandler creates a HTTP handler which loads the HTTP request and calls the "hello" service "say-hello" endpoint.

func NewSayHelloPayload

func NewSayHelloPayload(name string) *hello.SayHelloPayload

NewSayHelloPayload builds a hello service say-hello endpoint payload.

func SayHelloHelloPath

func SayHelloHelloPath(name string) string

SayHelloHelloPath returns the URL path to the hello service say-hello HTTP 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 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
	SayHello           http.Handler
	GenHTTPOpenapiJSON http.Handler
}

Server lists the hello service endpoint HTTP handlers.

func New

func New(
	e *hello.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,
	fileSystemGenHTTPOpenapiJSON http.FileSystem,
) *Server

New instantiates HTTP handlers for all the hello 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) Mount

func (s *Server) Mount(mux goahttp.Muxer)

Mount configures the mux to serve the hello endpoints.

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.