routing

Documentation

Index

• func NewRouter() *mux.Router
• type GenericError
• type InternalError
• type NotFoundError
• 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 GenericError

type GenericError struct {
	// in: body
	Body struct {
		// HTTP status code
		// example: 400
		// default: 400
		Code    int32 `json:"code"`
		Message error `json:"message"`
	} `json:"body"`
}

A GenericError is the default error message that is generated.

swagger:response genericError

type InternalError

type InternalError struct {
	// in: body
	Body struct {
		// HTTP status code
		// example: 500
		// default: 500
		Code    int32 `json:"code"`
		Message error `json:"message"`
	} `json:"body"`
}

A Internal is the error message that means something has gone wrong

swagger:response internalError

type NotFoundError

type NotFoundError struct {
	// in: body
	Body struct {
		// HTTP status code
		// example: 404
		// default: 404
		Code    int32 `json:"code"`
		Message error `json:"message"`
	} `json:"body"`
}

A NotFoundError is the error message that is generated when server could not find what was requested.

swagger:response notFoundError

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

func NewRoutes

func NewRoutes() (r *Routes)

NewRoutes creates and returns all the API routes