rest

Documentation

Index

• func Index(w http.ResponseWriter, r *http.Request)
• func NewRouter() *mux.Router
• type APIServer
  • func NewAPIServer(wg *sync.WaitGroup) *APIServer
  • func (s *APIServer) APIShutdownHandler(w http.ResponseWriter, r *http.Request)
  • func (s *APIServer) RunAPIServer()
• type Route
• type Routes

Functions

func Index

func Index(w http.ResponseWriter, r *http.Request)

Index returns a welcome message

func NewRouter

func NewRouter() *mux.Router

NewRouter returns a new Router which routes the REST request to the unique Handler

Types

type APIServer

type APIServer struct {
	http.Server
	// contains filtered or unexported fields
}

APIServer Receiver object for API Rest Server

func NewAPIServer

func NewAPIServer(wg *sync.WaitGroup) *APIServer

NewAPIServer provides an instance of APIServer

func (*APIServer) APIShutdownHandler

func (s *APIServer) APIShutdownHandler(w http.ResponseWriter, r *http.Request)

APIShutdownHandler provides shutdown handler for closing the REST Server It also closes the Database.

func (*APIServer) RunAPIServer

func (s *APIServer) RunAPIServer()

RunAPIServer starts the Database and Rest Server

type Route

type Route struct {
	Name        string
	Method      string
	Pattern     string
	HandlerFunc http.HandlerFunc
	QueryPairs  []string
}

Route defines a unique route for a REST request

type Routes

type Routes []Route

Routes define an array of routes supported by the application