router

Documentation

Index

• Variables
• type EndPoint
  • func NewEndPoint(endpoint string) *EndPoint
  • func NewRootPoint() *EndPoint
  • func (a *EndPoint) Delete(h ...Handler)
  • func (a *EndPoint) Get(h ...Handler)
  • func (a *EndPoint) Head(h ...Handler)
  • func (a *EndPoint) Patch(h ...Handler)
  • func (a *EndPoint) Post(h ...Handler)
  • func (a *EndPoint) Put(h ...Handler)
  • func (a *EndPoint) Sub(e *EndPoint) *EndPoint
  • func (a *EndPoint) URL() string
• type Handler
• type Router
  • func MakeRouter() *Router
  • func (r *Router) Register(epi *EndPoint) error
  • func (r *Router) Resolve(exchange *transport.Exchange)

Variables

var RESERVED_ENDPOINTS = map[string]struct{}{
	"public":  {},
	"private": {},
	"doc":     {},
	"docs":    {},
}

Types

type EndPoint

type EndPoint struct {
	Depth    int
	Endpoint string
	// contains filtered or unexported fields
}

func NewEndPoint

func NewEndPoint(endpoint string) *EndPoint

func NewRootPoint

func NewRootPoint() *EndPoint

func (*EndPoint) Delete

func (a *EndPoint) Delete(h ...Handler)

func (*EndPoint) Get

func (a *EndPoint) Get(h ...Handler)

func (*EndPoint) Head

func (a *EndPoint) Head(h ...Handler)

func (*EndPoint) Patch

func (a *EndPoint) Patch(h ...Handler)

func (*EndPoint) Post

func (a *EndPoint) Post(h ...Handler)

func (*EndPoint) Put

func (a *EndPoint) Put(h ...Handler)

func (*EndPoint) Sub

func (a *EndPoint) Sub(e *EndPoint) *EndPoint

func (*EndPoint) URL

func (a *EndPoint) URL() string

type Handler

type Handler func(req *generated.Request, res *generated.Response) error

Handler définit le type de fonction qui implémente HandlerInterface.

type Router

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

Router represents your API. It manages the association of URL paths with their corresponding handlers based on HTTP methods like GET, POST, PUT, PATCH, and DELETE. The Router also keeps track of whether it is deprecated.

func MakeRouter

func MakeRouter() *Router

MakeRouter creates and returns a new instance of Router. This function initializes a Router with its default values.

Returns: - *Router: A new instance of Router.

func (*Router) Register

func (r *Router) Register(epi *EndPoint) error

func (*Router) Resolve

func (r *Router) Resolve(exchange *transport.Exchange)

Resolve process the request and applies appropriate handlers

This function takes a router and an exchange object. It resolves the endpoint from the request, then applies the corresponding handlers based on the request method.

Parameters: - exchange: *transport.Exchange The exchange object containing request and response.

Returns: - err: error The error encountered during processing, if any.