routing

Documentation

Index

• func NewRouter() *mux.Router
• type Route
• type Routes
  • func NewRoutes() (r *Routes)

Functions

func NewRouter

func NewRouter() *mux.Router

NewRouter creates the router with all API routes and the static files handler

Types

type Route

type Route struct {
	Name          string
	Method        string
	Pattern       string
	HandlerFunc   http.HandlerFunc
	Authenticated bool
}

Route describes a single route

type Routes

type Routes struct {
	Routes []Route
}

Routes holds an array of Route. A note on swagger documentation. The path variables and query parameters are defined in ../doc.go. YOu need to manually associate params and routes.

func NewRoutes

func NewRoutes() (r *Routes)

NewRoutes creates and returns all the API routes