rooter

Documentation

Index

• Variables
• func MiddlewareLogger(next http.Handler) http.Handler
• func RegisterRoutes(mux *http.ServeMux, routes []Route, middlewares []Middleware)
• func ResponseFunc(s ResponseHandler) http.Handler
• type Middleware
• type Param
• type Response
  • func (s Response) Bytes() []byte
  • func (s Response) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type ResponseHandler
• type Route

Variables

var ResponseBadRequest = Response{
	StatusCode: http.StatusBadRequest,
	Message:    "bad request",
}

ResponseBadRequest is a standard way of serving a 400

var ResponseInternalServerError = Response{
	StatusCode: http.StatusInternalServerError,
	Message:    "internal server error",
}

ResponseInternalServerError is a standard way of serving a 500

var ResponseMethodNotAllowed = Response{
	StatusCode: http.StatusMethodNotAllowed,
	Message:    "method not allowed",
}

ResponseMethodNotAllowed is a standard way of serving a 405

var ResponseNotFound = Response{
	StatusCode: http.StatusNotFound,
	Message:    "not found",
}

ResponseNotFound is a standard way of serving a 404

var ResponseUnauthorized = Response{
	StatusCode: http.StatusUnauthorized,
	Message:    "unauthorized",
}

ResponseUnauthorized is a standard way of serving a 401

Functions

func MiddlewareLogger

func MiddlewareLogger(next http.Handler) http.Handler

MiddlewareLogger is a simple logging middleware

func RegisterRoutes

func RegisterRoutes(mux *http.ServeMux, routes []Route, middlewares []Middleware)

RegisterRoutes for a given mux

func ResponseFunc

func ResponseFunc(s ResponseHandler) http.Handler

ResponseFunc is a shortcut for making sure a ResponseHandler can be used as a http.Handler

Types

type Middleware

type Middleware func(next http.Handler) http.Handler

Middleware for wrapping http.Handlers

type Param

type Param struct {
	Name     string
	Required bool
}

Param is a route paramerter

type Response

type Response struct {
	StatusCode int         `json:"-"`
	State      bool        `json:"state"`
	Message    string      `json:"message"`
	Data       interface{} `json:"data"`
	ExtraData  interface{} `json:"extraData"`
}

Response is a standard response format to use for API responses

func (Response) Bytes

func (s Response) Bytes() []byte

Bytes return

func (Response) ServeHTTP

func (s Response) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP writes the response as JSON

type ResponseHandler

type ResponseHandler func(w http.ResponseWriter, r *http.Request) Response

ResponseHandler is a simpler than http.HandlerFunc for enforcing the proper usage of Response

type Route

type Route struct {
	Path       string
	Handler    http.Handler
	Params     []Param
	Middleware []Middleware
	Payload    interface{}
	Response   interface{}
	// Extra Config
	ExcludeFromTypeScript bool
}

Route is an API Route