router

Documentation

Overview

Package router is the package where we define web routes on elasthink

Index

• type RouterWrap
  • func InitializeRoute() *RouterWrap
  • func (rw *RouterWrap) RegisterAppHandler()
  • func (rw *RouterWrap) RegisterHandler()
  • func (rw *RouterWrap) RegisterInternalHandler()

Types

type RouterWrap

type RouterWrap struct {
	Router *mux.Router
}

RouterWrap is a custom wrapper type for router, you can add more configuration fields here

func InitializeRoute

func InitializeRoute() *RouterWrap

InitializeRoute is a function which returns new RouterWrap which has a mux's router inside

func (*RouterWrap) RegisterAppHandler

func (rw *RouterWrap) RegisterAppHandler()

RegisterAppHandler register app handlers (external endpoints)

func (*RouterWrap) RegisterHandler

func (rw *RouterWrap) RegisterHandler()

RegisterHandler is a RouterWrap 'method' to register your API endpoints. Usually handler calls services module

func (*RouterWrap) RegisterInternalHandler

func (rw *RouterWrap) RegisterInternalHandler()

RegisterInternalHandler registers internal handlers (internal endpoints)