routes

Documentation

Index

• type APIRouter
  • func NewAPIRouter(opts ...Setup) (*APIRouter, error)
  • func (svc *APIRouter) GetHandlers() *Handler
  • func (svc *APIRouter) MapRoute() *chi.Mux
  • func (svc *APIRouter) Run()
• type Handler
• type Setup
  • func WithSvcOptConfig(c *configs.ParameterConfig) Setup
  • func WithSvcOptHandler(r *Handler) Setup
  • func WithSvcOptMux(m *chi.Mux) Setup

Types

type APIRouter

type APIRouter struct {
	Mux      *chi.Mux
	Address  string
	Config   *configs.ParameterConfig
	DBHandle *drivers.DBHandle
	Handlers *Handler
}

APIRouter the svc map

func NewAPIRouter

func NewAPIRouter(opts ...Setup) (*APIRouter, error)

NewAPIRouter service new instance

func (*APIRouter) GetHandlers

func (svc *APIRouter) GetHandlers() *Handler

GetHandlers is the mapping of all the handlers

func (*APIRouter) MapRoute

func (svc *APIRouter) MapRoute() *chi.Mux

MapRoute route map all endpoints

func (*APIRouter) Run

func (svc *APIRouter) Run()

Run the http server based on settings

type Handler

type Handler struct {
	BuildingHandler buildingHandler
}

Handler wraps all handler

type Setup

type Setup func(*APIRouter)

Setup options settings

func WithSvcOptConfig

func WithSvcOptConfig(c *configs.ParameterConfig) Setup

WithSvcOptConfig opts for mux

func WithSvcOptHandler

func WithSvcOptHandler(r *Handler) Setup

WithSvcOptHandler opts for handler

func WithSvcOptMux

func WithSvcOptMux(m *chi.Mux) Setup

WithSvcOptMux opts for mux