server

package
v0.0.0-...-d47a9da Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 22, 2024 License: BSD-3-Clause Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DataRecordsPath 

func DataRecordsPath(recordID int64) string

DataRecordsPath returns the URL path to the records service data HTTP endpoint.

func DecodeDataRequest 

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

DecodeDataRequest returns a decoder for requests sent to the records data endpoint.

func DecodeMetaRequest 

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

DecodeMetaRequest returns a decoder for requests sent to the records meta endpoint.

func DecodeResolvedRequest 

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

DecodeResolvedRequest returns a decoder for requests sent to the records resolved endpoint.

func EncodeDataError 

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

EncodeDataError returns an encoder for errors returned by the data records endpoint.

func EncodeDataResponse 

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

EncodeDataResponse returns an encoder for responses returned by the records data endpoint.

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 records 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 records meta endpoint.

func EncodeResolvedError 

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

EncodeResolvedError returns an encoder for errors returned by the resolved records endpoint.

func EncodeResolvedResponse 

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

EncodeResolvedResponse returns an encoder for responses returned by the records resolved endpoint.

func MetaRecordsPath 

func MetaRecordsPath(recordID int64) string

MetaRecordsPath returns the URL path to the records service meta HTTP endpoint.

func Mount 

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

Mount configures the mux to serve the records endpoints.

func MountCORSHandler 

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

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

func MountDataHandler 

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

MountDataHandler configures the mux to serve the "records" service "data" endpoint.

func MountMetaHandler 

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

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

func MountResolvedHandler 

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

MountResolvedHandler configures the mux to serve the "records" service "resolved" endpoint.

func NewCORSHandler 

func NewCORSHandler() http.Handler

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

func NewDataHandler 

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

NewDataHandler creates a HTTP handler which loads the HTTP request and calls the "records" service "data" endpoint.

func NewDataPayload 

func NewDataPayload(recordID int64, auth *string) *records.DataPayload

NewDataPayload builds a records service data endpoint payload.

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 "records" service "meta" endpoint.

func NewMetaPayload 

func NewMetaPayload(recordID int64, auth *string) *records.MetaPayload

NewMetaPayload builds a records service meta endpoint payload.

func NewResolvedHandler 

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

NewResolvedHandler creates a HTTP handler which loads the HTTP request and calls the "records" service "resolved" endpoint.

func NewResolvedPayload 

func NewResolvedPayload(recordID int64, auth *string) *records.ResolvedPayload

NewResolvedPayload builds a records service resolved endpoint payload.

func ResolvedRecordsPath 

func ResolvedRecordsPath(recordID int64) string

ResolvedRecordsPath returns the URL path to the records service resolved HTTP endpoint.

Types

type DataBadRequestResponseBody 

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

DataBadRequestResponseBody is the type of the "records" service "data" endpoint HTTP response body for the "bad-request" error.

func NewDataBadRequestResponseBody 

func NewDataBadRequestResponseBody(res *goa.ServiceError) *DataBadRequestResponseBody

NewDataBadRequestResponseBody builds the HTTP response body from the result of the "data" endpoint of the "records" service.

type DataForbiddenResponseBody 

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

DataForbiddenResponseBody is the type of the "records" service "data" endpoint HTTP response body for the "forbidden" error.

func NewDataForbiddenResponseBody 

func NewDataForbiddenResponseBody(res *goa.ServiceError) *DataForbiddenResponseBody

NewDataForbiddenResponseBody builds the HTTP response body from the result of the "data" endpoint of the "records" service.

type DataNotFoundResponseBody 

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

DataNotFoundResponseBody is the type of the "records" service "data" endpoint HTTP response body for the "not-found" error.

func NewDataNotFoundResponseBody 

func NewDataNotFoundResponseBody(res *goa.ServiceError) *DataNotFoundResponseBody

NewDataNotFoundResponseBody builds the HTTP response body from the result of the "data" endpoint of the "records" service.

type DataUnauthorizedResponseBody 

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

DataUnauthorizedResponseBody is the type of the "records" service "data" endpoint HTTP response body for the "unauthorized" error.

func NewDataUnauthorizedResponseBody 

func NewDataUnauthorizedResponseBody(res *goa.ServiceError) *DataUnauthorizedResponseBody

NewDataUnauthorizedResponseBody builds the HTTP response body from the result of the "data" endpoint of the "records" service.

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 "records" 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 "records" 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 "records" 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 "records" 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 "records" 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 "records" 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 "records" 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 "records" 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 ResolvedBadRequestResponseBody 

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

ResolvedBadRequestResponseBody is the type of the "records" service "resolved" endpoint HTTP response body for the "bad-request" error.

func NewResolvedBadRequestResponseBody 

func NewResolvedBadRequestResponseBody(res *goa.ServiceError) *ResolvedBadRequestResponseBody

NewResolvedBadRequestResponseBody builds the HTTP response body from the result of the "resolved" endpoint of the "records" service.

type ResolvedForbiddenResponseBody 

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

ResolvedForbiddenResponseBody is the type of the "records" service "resolved" endpoint HTTP response body for the "forbidden" error.

func NewResolvedForbiddenResponseBody 

func NewResolvedForbiddenResponseBody(res *goa.ServiceError) *ResolvedForbiddenResponseBody

NewResolvedForbiddenResponseBody builds the HTTP response body from the result of the "resolved" endpoint of the "records" service.

type ResolvedNotFoundResponseBody 

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

ResolvedNotFoundResponseBody is the type of the "records" service "resolved" endpoint HTTP response body for the "not-found" error.

func NewResolvedNotFoundResponseBody 

func NewResolvedNotFoundResponseBody(res *goa.ServiceError) *ResolvedNotFoundResponseBody

NewResolvedNotFoundResponseBody builds the HTTP response body from the result of the "resolved" endpoint of the "records" service.

type ResolvedUnauthorizedResponseBody 

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

ResolvedUnauthorizedResponseBody is the type of the "records" service "resolved" endpoint HTTP response body for the "unauthorized" error.

func NewResolvedUnauthorizedResponseBody 

func NewResolvedUnauthorizedResponseBody(res *goa.ServiceError) *ResolvedUnauthorizedResponseBody

NewResolvedUnauthorizedResponseBody builds the HTTP response body from the result of the "resolved" endpoint of the "records" service.

type Server 

type Server struct {
	Mounts   []*MountPoint
	Data     http.Handler
	Meta     http.Handler
	Resolved http.Handler
	CORS     http.Handler
}

Server lists the records service endpoint HTTP handlers.

func New 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.