endpoint

package
v0.0.1 Latest Latest
Warning

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

 Go to latest Published: Sep 16, 2025 License: Apache-2.0 Imports: 5 Imported by: 5

Documentation

Index

Constants

View Source 
const (
	// EventError is emitted when an error occurs during request processing.
	EventError event.EventType = "event_error"

	// EventOutputError event is emitted when an output error occurs.
	EventOutputError event.EventType = "event_output_error"
)

Constants for event types.

Variables

This section is empty.

Functions

func NewDefinitions 

func NewDefinitions(
	definitions ...Definition,
) (*defaultDefinitions, error)

Types

type DefaultDefinition 

type DefaultDefinition struct {
	URLVal     string
	MethodVal  string
	StackVal   Stack
	HandlerVal http.HandlerFunc
}

DefaultDefinition represents an endpoint definition.

func NewDefinition 

func NewDefinition(
	url string,
	method string,
	stack Stack,
	handler http.HandlerFunc,
) *DefaultDefinition

NewDefinition creates a new endpoint definition.

Parameters:

  • url: The URL of the endpoint. Defaults to "/" if empty.
  • method: The HTTP method of the endpoint.
  • stack: The middleware stack for the endpoint.
  • handler: The handler for the endpoint.

Returns:

  • *DefaultDefinition: A new DefaultDefinition instance.

func (*DefaultDefinition) Clone 

func (d *DefaultDefinition) Clone() *DefaultDefinition

Clone creates a deep copy of an endpoint definition and returns the cloned endpoint definition.

Parameters:

  • opts: Options to apply to the cloned definition.

Returns:

  • *Definition: the cloned definition.

func (*DefaultDefinition) Handler 

func (d *DefaultDefinition) Handler() http.HandlerFunc

Handler returns the handler of the endpoint.

Returns:

  • http.HandlerFunc: The handler of the endpoint.

func (*DefaultDefinition) Method 

func (d *DefaultDefinition) Method() string

Method returns the HTTP method of the endpoint.

Returns:

  • string: The HTTP method of the endpoint.

func (*DefaultDefinition) Stack 

func (d *DefaultDefinition) Stack() Stack

Stack returns the middleware stack of the endpoint.

Returns:

  • Stack: The middleware stack of the endpoint.

func (*DefaultDefinition) URL 

func (d *DefaultDefinition) URL() string

URL returns the URL of the endpoint.

Returns:

  • string: The URL of the endpoint.

func (*DefaultDefinition) WithHandler 

func (d *DefaultDefinition) WithHandler(handler http.HandlerFunc) Definition

WithHandler sets the handler of the endpoint. It returns a new endpoint definition.

Parameters:

  • handler: The handler of the endpoint.

Returns:

  • Definition: A new Definition.

func (*DefaultDefinition) WithMethod 

func (d *DefaultDefinition) WithMethod(method string) Definition

WithMethod sets the method of the endpoint. It returns a new endpoint definition.

Parameters:

  • method: The method of the endpoint.

Returns:

  • Definition: A new Definition.

func (*DefaultDefinition) WithMiddlewareStack 

func (d *DefaultDefinition) WithMiddlewareStack(stack Stack) Definition

WithMiddlewareStack sets the middleware stack of the endpoint. It returns a new endpoint definition.

Parameters:

  • stack: The middleware stack.

Returns:

  • Definition: A new Definition.

func (*DefaultDefinition) WithURL 

func (d *DefaultDefinition) WithURL(url string) Definition

WithURL sets the URL of the endpoint. Defaults to "/" if empty. It returns a new endpoint definition.

Parameters:

  • url: The URL of the endpoint.

Returns:

  • Definition: A new Definition.

type DefaultEndpoint 

type DefaultEndpoint struct {
	URLVal         string
	MethodVal      string
	MiddlewaresVal Middlewares
	HandlerVal     http.HandlerFunc // Optional handler for the endpoint.
}

DefaultEndpoint represents an API endpoint with middlewares.

func NewEndpoint 

func NewEndpoint(url string, method string) *DefaultEndpoint

NewEndpoint creates a new defaultEndpoint with the given details.

Parameters:

  • url: The URL of the endpoint.
  • method: The HTTP method of the endpoint.
  • middlewares: The middlewares to apply to the endpoint.

Returns:

  • *defaultEndpoint: A new defaultEndpoint instance.

func (*DefaultEndpoint) Handler 

func (e *DefaultEndpoint) Handler() http.HandlerFunc

Handler returns the handler of the endpoint.

Returns:

  • http.HandlerFunc: The handler of the endpoint.

func (*DefaultEndpoint) Method 

func (e *DefaultEndpoint) Method() string

Method returns the HTTP method of the endpoint.

Returns:

  • string: The HTTP method of the endpoint.

func (*DefaultEndpoint) Middlewares 

func (e *DefaultEndpoint) Middlewares() Middlewares

Middlewares returns the middlewares of the endpoint. If no middlewares are set, it returns an empty Middlewares instance.

Returns:

  • Middlewares: The middlewares of the endpoint.

func (*DefaultEndpoint) URL 

func (e *DefaultEndpoint) URL() string

URL returns the URL of the endpoint.

Returns:

  • string: The URL of the endpoint.

func (*DefaultEndpoint) WithHandler 

func (e *DefaultEndpoint) WithHandler(handler http.HandlerFunc) Endpoint

WithHandler sets the handler for the endpoint. It returns a new endpoint.

Parameters:

  • handler: The handler for the endpoint.

Returns:

  • Endpoint: A new Endpoint.

func (*DefaultEndpoint) WithMethod 

func (e *DefaultEndpoint) WithMethod(method string) Endpoint

WithMethod sets the method of the endpoint. It returns a new endpoint.

Parameters:

  • method: The method of the endpoint.

Returns:

  • Endpoint: A new Endpoint.

func (*DefaultEndpoint) WithMiddlewares 

func (e *DefaultEndpoint) WithMiddlewares(middlewares Middlewares) Endpoint

WithMiddlewares sets the middlewares for the endpoint. It returns a new endpoint.

Parameters:

  • middlewares: The middlewares to apply to the endpoint.

Returns:

  • Endpoint: A new Endpoint.

func (*DefaultEndpoint) WithURL 

func (e *DefaultEndpoint) WithURL(url string) Endpoint

WithURL sets the URL of the endpoint. It returns a new endpoint.

Parameters:

  • url: The URL of the endpoint.

Returns:

  • Endpoint: A new Endpoint.

type DefaultHandler 

type DefaultHandler[Input any] struct {
	// contains filtered or unexported fields
}

DefaultHandler represents an endpoint with input, business logic, and output.

func NewHandler 

func NewHandler[Input any](
	inputHandler InputHandler[Input],
	handlerLogicFn HandlerLogicFn[Input],
	errorHandler ErrorHandler,
	outputHandler OutputHandler,
) *DefaultHandler[Input]

NewHandler creates a new handler. During requst handling it executes common endpoints logic. It calls the input handler, handler logic, and output handler. If an error occurs during output handling, it will write a 500 error.

Parameters:

  • inputHandler: The input handler.
  • handlerLogicFn: The handler logic function.
  • errorHandler: The error handler.
  • outputHandler: The output handler.

Returns:

  • *DefaultHandler: A new DefaultHandler instance.

func (*DefaultHandler[Input]) Handle 

func (h *DefaultHandler[Input]) Handle(
	w http.ResponseWriter, r *http.Request,
)

Handle executes common endpoints logic. It calls the input handler, handler logic, and output handler.

Parameters:

  • w: The HTTP response writer.
  • r: The HTTP request.

func (*DefaultHandler[Input]) WithEmitterLogger 

func (h *DefaultHandler[Input]) WithEmitterLogger(
	emitterLogger event.EmitterLogger,
) *DefaultHandler[Input]

WithEmitterLogger adds an emitter logger to the handler and returns a new handler instance.

Parameters:

  • emitterLogger: The emitter logger.

Returns:

  • *DefaultHandler: A new handler instance.

func (*DefaultHandler[Input]) WithErrorHandler 

func (h *DefaultHandler[Input]) WithErrorHandler(
	errorHandler ErrorHandler,
) *DefaultHandler[Input]

WithErrorHandler adds an error handler to the handler and returns a new handler instance.

Parameters:

  • errorHandler: The error handler.

Returns:

  • *DefaultHandler: A new handler instance.

func (*DefaultHandler[Input]) WithHandlerLogicFn 

func (h *DefaultHandler[Input]) WithHandlerLogicFn(
	handlerLogicFn HandlerLogicFn[Input],
) *DefaultHandler[Input]

WithHandlerLogicFn adds a handler logic function to the handler and returns a new handler instance.

Parameters:

  • handlerLogicFn: The handler logic function.

Returns:

  • *DefaultHandler: A new handler instance.

func (*DefaultHandler[Input]) WithInputHandler 

func (h *DefaultHandler[Input]) WithInputHandler(
	inputHandler InputHandler[Input],
) *DefaultHandler[Input]

WithInputHandler adds an input handler to the handler and returns a new handler instance.

Parameters:

  • inputHandler: The input handler.

Returns:

  • *DefaultHandler: A new handler instance.

type DefaultMiddlewares 

type DefaultMiddlewares struct {
	// contains filtered or unexported fields
}

DefaultMiddlewares is a slice of Middleware functions.

func NewMiddlewares 

func NewMiddlewares(middlewares ...Middleware) *DefaultMiddlewares

NewMiddlewares creates a new DefaultMiddlewares instance with the provided middlewares.

Parameters:

  • middlewares: The middlewares to add to the list.

Returns:

  • *DefaultMiddlewares: A new DefaultMiddlewares instance.

func (DefaultMiddlewares) Add 

func (m DefaultMiddlewares) Add(
	middlewares ...Middleware,
) *DefaultMiddlewares

Add adds one or more middlewares to the list and returns a new DefaultMiddlewares instance.

Parameters:

  • middlewares: The middlewares to add to the list.

func (DefaultMiddlewares) Chain 

func (m DefaultMiddlewares) Chain(h http.Handler) http.Handler

Chain applies a sequence of middlewares to an http.Handler. During a request the middlewaress are applied in the order they are provided. The middlewares are applied so that the first middleware in the list becomes the outermost wrapper.

Example with middlewares m1, m2 

Chain(finalHandler) yields m1(m2(finalHandler)).

Parameters:

  • h: The http.Handler to wrap.

Returns:

  • http.Handler: The wrapped http.Handler.

func (DefaultMiddlewares) Middlewares 

func (m DefaultMiddlewares) Middlewares() []Middleware

Middlewares returns the middlewares in the list.

Returns:

  • []Middleware: The middlewares in the list.

type DefaultStack 

type DefaultStack struct {
	// contains filtered or unexported fields
}

DefaultStack manages a list of middleware wrappers with concurrency safety for editing the list.

func NewStack 

func NewStack(wrappers ...Wrapper) *DefaultStack

NewStack creates and returns an initialized DefaultStack.

Parameters:

  • wrappers: The initial list of middleware wrappers.

Returns:

  • *DefaultStack: A new DefaultStack instance.

func (*DefaultStack) AddWrapper 

func (s *DefaultStack) AddWrapper(w Wrapper) Stack

Add appends a new middleware Wrapper to the stack and returns the stack for chaining.

Parameters:

  • w: The wrapper to add.

Returns:

  • *Stack: The updated middleware stack.

func (*DefaultStack) Clone 

func (s *DefaultStack) Clone() Stack

Clone creates a deep copy of the Stack.

Returns:

  • *Stack: The cloned middleware stack.

func (*DefaultStack) InsertAfter 

func (s *DefaultStack) InsertAfter(
	id string, w Wrapper,
) (Stack, bool)

InsertAfter inserts a middleware Wrapper after the one with the specified ID. Returns true if a matching wrapper was found and insertion happened after it. If no match is found, the new wrapper is appended and false is returned.

Parameters:

  • id: The ID of the wrapper to insert after.
  • w: The wrapper to insert.

Returns:

  • *Stack: The updated middleware stack.
  • bool: True if a matching wrapper was found and insertion succeeded.

func (*DefaultStack) InsertBefore 

func (s *DefaultStack) InsertBefore(
	id string, w Wrapper,
) (Stack, bool)

InsertBefore inserts a middleware Wrapper before the one with the specified ID. Returns true if a matching wrapper was found and insertion happened before it; if no match is found, the new wrapper is appended and false is returned.

Parameters:

  • id: The ID of the wrapper to insert before.
  • w: The wrapper to insert.

Returns:

  • *Stack: The updated middleware stack.
  • bool: True if a matching wrapper was found and insertion succeeded.

func (*DefaultStack) Middlewares 

func (s *DefaultStack) Middlewares() Middlewares

Middlewares returns the middlewares in the stack.

Returns:

  • Middlewares: The list of middlewares in the stack.

func (*DefaultStack) Remove 

func (s *DefaultStack) Remove(id string) (Stack, bool)

Remove deletes the middleware Wrapper with the specified ID from the stack. Returns true if the middleware was found and removed; false otherwise.

Parameters:

  • id: The ID of the wrapper to remove.

Returns:

  • *Stack: The updated middleware stack.
  • bool: True if the middleware was found and removed; false otherwise.

func (*DefaultStack) Wrappers 

func (s *DefaultStack) Wrappers() []Wrapper

Wrappers returns the list of middleware wrappers in the stack.

Returns:

  • []Wrapper: The list of middleware wrappers in the stack.

type DefaultWrapper 

type DefaultWrapper struct {
	// contains filtered or unexported fields
}

DefaultWrapper encapsulates a middleware with an identifier and optional metadata. ID can be used to identify the middleware type (e.g. for reordering or documentation). Data can carry any type of additional information.

func NewWrapper 

func NewWrapper(
	id string, middleware Middleware,
) *DefaultWrapper

NewWrapper creates a new middleware DefaultWrapper.

Parameters:

  • m: The middleware to wrap.
  • id: The ID of the wrapper.

Returns:

  • *DefaultWrapper: A new DefaultWrapper instance.

func (*DefaultWrapper) Data 

func (m *DefaultWrapper) Data() any

Data returns the data attached to the wrapper.

Returns:

  • any: The data attached to the wrapper.

func (*DefaultWrapper) ID 

func (m *DefaultWrapper) ID() string

ID returns the ID of the wrapper.

Returns:

  • string: The ID of the wrapper.

func (*DefaultWrapper) Middleware 

func (m *DefaultWrapper) Middleware() Middleware

ID returns the ID of the wrapper.

Returns:

  • string: The ID of the wrapper.

func (*DefaultWrapper) WithData 

func (m *DefaultWrapper) WithData(data any) *DefaultWrapper

WithData returns a new DefaultWrapper with the given data and returns a new DefaultWrapper.

Parameters:

  • data: The data to attach to the wrapper.

Returns:

  • *DefaultWrapper: A new DefaultWrapper instance.

type Definition 

type Definition interface {
	URL() string
	Method() string
	Stack() Stack
	Handler() http.HandlerFunc
	WithURL(string) Definition
	WithMethod(string) Definition
	WithMiddlewareStack(Stack) Definition
	WithHandler(http.HandlerFunc) Definition
}

Endpoint represents an API endpoint with middlewares.

type Definitions 

type Definitions interface {
	ToEndpoints() []Endpoint
}

Definitions is a new list of endpoint definitions.

type Endpoint 

type Endpoint interface {
	URL() string
	Method() string
	Middlewares() Middlewares
	Handler() http.HandlerFunc
	WithURL(string) Endpoint
	WithMethod(string) Endpoint
	WithMiddlewares(Middlewares) Endpoint
	WithHandler(http.HandlerFunc) Endpoint
}

Endpoint represents an API endpoint with middlewares.

type ErrorHandler 

type ErrorHandler interface {
	Handle(err error) (int, apierror.APIError)
}

ErrorHandler handles apierror and maps them to appropriate HTTP responses.

type Handler 

type Handler[Input any] interface {
	Handle(w http.ResponseWriter, r *http.Request)
}

Handler is an interface for handling endpoints.

type HandlerLogicFn 

type HandlerLogicFn[Input any] func(
	w http.ResponseWriter, r *http.Request, i *Input,
) (any, error)

HandlerLogicFn is a function for handling endpoint logic.

type InputHandler 

type InputHandler[Input any] interface {
	Handle(w http.ResponseWriter, r *http.Request) (*Input, error)
}

InputHandler defines how to process the request input.

type Middleware 

type Middleware func(http.Handler) http.Handler

Middleware represents a function that wraps an http.Handler with additional behavior. A Middleware typically performs actions before and/or after calling the next handler.

Example: 

finalHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
    // final processing
})
wrappedHandler := Apply(finalHandler, middleware1, middleware2)

type Middlewares 

type Middlewares interface {
	Chain(h http.Handler) http.Handler
}

Middlewares is a collection of Middleware functions.

type OutputHandler 

type OutputHandler interface {
	Handle(
		w http.ResponseWriter,
		r *http.Request,
		out any,
		outputError error,
		statusCode int,
	) error
}

OutputHandler processes and writes the endpoint response.

type Stack 

type Stack interface {
	Wrappers() []Wrapper
	Middlewares() Middlewares
	Clone() Stack
	AddWrapper(w Wrapper) Stack
	InsertBefore(id string, w Wrapper) (Stack, bool)
	InsertAfter(id string, w Wrapper) (Stack, bool)
	Remove(id string) (Stack, bool)
}

Stack is an interface for managing a list of middleware wrappers.

type Wrapper 

type Wrapper interface {
	ID() string
	Middleware() Middleware
	Data() any
}

Wrapper is an interface for a middleware wrapper. It encapsulates a Middleware with an identifier and optional metadata.

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.