serves

Documentation

Index

• Variables
• func FilterEndpoints[T Endpoint](filter func(e T) bool) []T
• func HTTPEndpointSortByPathLen(a, b *HTTPEndpoint) bool
• func RegisterEndpoints(eps ...Endpoint)
• type Endpoint
• type EndpointDesc
  • func (e EndpointDesc) String() string
• type HTTPEndpoint
  • func (e *HTTPEndpoint) GetEndpointDesc() *EndpointDesc
  • func (e *HTTPEndpoint) Normalize()
  • func (e HTTPEndpoint) String() string
  • func (e *HTTPEndpoint) Validate() error

Variables

var Endpoints []Endpoint //nolint:gochecknoglobals

Functions

func FilterEndpoints

func FilterEndpoints[T Endpoint](filter func(e T) bool) []T

func HTTPEndpointSortByPathLen

func HTTPEndpointSortByPathLen(a, b *HTTPEndpoint) bool

func RegisterEndpoints

func RegisterEndpoints(eps ...Endpoint)

Types

type Endpoint

type Endpoint interface {
	String() string
}

type EndpointDesc

type EndpointDesc struct {
	Name                   string
	Description            string
	Selector               string
	Tags                   []string
	Metas                  map[string]string
	Disabled               bool
	DeprecationDescription string
}

func (EndpointDesc) String

func (e EndpointDesc) String() string

type HTTPEndpoint

type HTTPEndpoint struct {
	EndpointDesc

	Method      string
	Path        string
	Handler     http.Handler
	HandlerFunc func(http.ResponseWriter, *http.Request)
	Middleware  func(http.Handler) http.Handler

	Children []*HTTPEndpoint

	Methods     []string
	Middlewares []func(http.Handler) http.Handler
}

func (*HTTPEndpoint) GetEndpointDesc

func (e *HTTPEndpoint) GetEndpointDesc() *EndpointDesc

func (*HTTPEndpoint) Normalize

func (e *HTTPEndpoint) Normalize()

func (HTTPEndpoint) String

func (e HTTPEndpoint) String() string

func (*HTTPEndpoint) Validate

func (e *HTTPEndpoint) Validate() error