resolver

Documentation

Overview

Package resolver resolves a http request to an endpoint

Index

• Variables
• func StaticNamespace(ns string) func(*fiber.Ctx) string
• type Endpoint
• type Option
  • func WithHandler(h string) Option
  • func WithNamespace(n func(*fiber.Ctx) string) Option
• type Options
  • func NewOptions(opts ...Option) Options
• type Resolver

Variables

var (
	ErrNotFound    = errors.New("not found")
	ErrInvalidPath = errors.New("invalid path")
)

Functions

func StaticNamespace

func StaticNamespace(ns string) func(*fiber.Ctx) string

StaticNamespace returns the same namespace for each request

Types

type Endpoint

type Endpoint struct {
	// e.g greeter
	Name string
	// HTTP Host e.g example.com
	Host string
	// HTTP Methods e.g GET, POST
	Method string
	// HTTP Path e.g /greeter.
	Path string
}

Endpoint is the endpoint for a http request

type Option

type Option func(o *Options)

func WithHandler

func WithHandler(h string) Option

WithHandler sets the handler being used

func WithNamespace

func WithNamespace(n func(*fiber.Ctx) string) Option

WithNamespace sets the function which determines the namespace for a request

type Options

type Options struct {
	Handler   string
	Namespace func(ctx *fiber.Ctx) string
}

func NewOptions

func NewOptions(opts ...Option) Options

NewOptions returns new initialised options

type Resolver

type Resolver interface {
	Resolve(c *fiber.Ctx) (*Endpoint, error)
	String() string
}

Resolver resolves requests to endpoints