router

README

router

-- import "github.com/rickbassham/example-go/chiapi/router"

Package router is used to define the routes to our request handlers.

Usage

func NewRouter

func NewRouter(h Handler, log *zap.Logger, nr newrelic.Application, tokenAuth *jwtauth.JWTAuth, version, corsOrigin string) http.Handler

NewRouter creates a new CORS enabled router for our API. All requests will be logged and instrumented with New Relic.

type Handler

type Handler interface {
	Health(w http.ResponseWriter, r *http.Request)
	Protected(w http.ResponseWriter, r *http.Request)
	NotFound(w http.ResponseWriter, r *http.Request)
	Unauthorized(w http.ResponseWriter, r *http.Request)
}

Handler exposes the functions for handling web requests.

Documentation

Overview

Package router is used to define the routes to our request handlers.

Index

• func NewRouter(h Handler, log *zap.Logger, nr newrelic.Application, ...) http.Handler
• type Handler

Functions

func NewRouter

func NewRouter(h Handler, log *zap.Logger, nr newrelic.Application, tokenAuth *jwtauth.JWTAuth, version, corsOrigin string) http.Handler

NewRouter creates a new CORS enabled router for our API. All requests will be logged and instrumented with New Relic.

Types

type Handler

type Handler interface {
	Health(w http.ResponseWriter, r *http.Request)
	Cached(w http.ResponseWriter, r *http.Request)
	Protected(w http.ResponseWriter, r *http.Request)
	NotFound(w http.ResponseWriter, r *http.Request)
	Unauthorized(w http.ResponseWriter, r *http.Request)
}

Handler exposes the functions for handling web requests.