presentation

Documentation

Index

• type DecoderFn
• type EncoderFn
• type EndpointFn
• type HandlerFn
• type MiddlewareFn
• type ResourceConfig
• type Route
• type Router
  • func NewRouter() *Router
  • func (r *Router) Build(ctx app.Context) *Router
  • func (r *Router) Register(ctx app.Context, routes []Route) *Router
  • func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request)
  • func (r *Router) Use(handler MiddlewareFn) *Router

Types

type DecoderFn

type DecoderFn func(ctx app.Context, w http.ResponseWriter, req *http.Request, route Route) (any, error)

type EncoderFn

type EncoderFn func(ctx app.Context, w http.ResponseWriter, response response.Response, route Route) error

type EndpointFn

type EndpointFn func(ctx app.Context, resource any) (response.Response, error)

type HandlerFn

type HandlerFn func(ctx app.Context, w http.ResponseWriter, req *http.Request) error

type MiddlewareFn

type MiddlewareFn func(h HandlerFn, route Route) HandlerFn

type ResourceConfig

type ResourceConfig interface {
	Attributes() any
	Relationships() any
}

type Route

type Route interface {
	Path() string
	ResourceConfig() ResourceConfig
	Method() string
	Decoder() DecoderFn
	Endpoint() EndpointFn
	Encoder() EncoderFn
}

type Router

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

func NewRouter

func NewRouter() *Router

func (*Router) Build

func (r *Router) Build(ctx app.Context) *Router

func (*Router) Register

func (r *Router) Register(ctx app.Context, routes []Route) *Router

func (*Router) ServeHTTP

func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request)

func (*Router) Use

func (r *Router) Use(handler MiddlewareFn) *Router