Documentation
¶
Overview ¶
Package chttp helps setup a http server with routing, middlewares, and more.
Index ¶
- Variables
- func NewHandler(p NewHandlerParams) http.Handler
- type HTMLDir
- type HTMLRenderer
- type HTMLRouter
- type Middleware
- type NewHTMLRendererParams
- type NewHTMLRouterParams
- type NewHandlerParams
- type NewServerParams
- type ReaderWriter
- func (rw *ReaderWriter) ReadJSON(w http.ResponseWriter, req *http.Request, body interface{}) bool
- func (rw *ReaderWriter) WriteHTML(w http.ResponseWriter, r *http.Request, p WriteHTMLParams)
- func (rw *ReaderWriter) WriteHTMLError(w http.ResponseWriter, r *http.Request, err error)
- func (rw *ReaderWriter) WriteJSON(w http.ResponseWriter, p WriteJSONParams)
- type RequestLoggerMiddleware
- type Route
- type Router
- type Server
- type StaticDir
- type WriteHTMLParams
- type WriteJSONParams
Constants ¶
This section is empty.
Variables ¶
var URLParams = mux.Vars
URLParams returns the route variables for the current request, if any
var WireModule = wire.NewSet( NewReaderWriter, NewRequestLoggerMiddleware, wire.Struct(new(NewServerParams), "*"), NewServer, wire.Struct(new(NewHTMLRouterParams), "*"), NewHTMLRouter, wire.Struct(new(NewHTMLRendererParams), "*"), NewHTMLRenderer, )
WireModule can be used as part of google/wire setup.
Functions ¶
func NewHandler ¶
func NewHandler(p NewHandlerParams) http.Handler
NewHandler creates a http.Handler with the given routes and middlewares. The handler can be used with a http.Server or as an argument to StartServer.
Types ¶
type HTMLDir ¶
HTMLDir is a directory that can be embedded or found on the host system. It should contain sub-directories and files to support the WriteHTML function in ReaderWriter.
type HTMLRenderer ¶
type HTMLRenderer struct {
// contains filtered or unexported fields
}
HTMLRenderer provides functionality in rendering templatized HTML along with HTML components
func NewHTMLRenderer ¶
func NewHTMLRenderer(p NewHTMLRendererParams) (*HTMLRenderer, error)
NewHTMLRenderer creates a new HTMLRenderer with HTML templates stored in dir and registers the provided HTML components
type HTMLRouter ¶
type HTMLRouter struct {
// contains filtered or unexported fields
}
HTMLRouter provides a route that exposes the StaticDir and handles server-side HTML components
func NewHTMLRouter ¶
func NewHTMLRouter(p NewHTMLRouterParams) (*HTMLRouter, error)
NewHTMLRouter instantiates a new HTMLRouter
func (*HTMLRouter) Routes ¶
func (ro *HTMLRouter) Routes() []Route
Routes defines the /static/ route that serves the StaticDir
type Middleware ¶
Middleware is a function that takes in a http.Handler and returns one as well. It allows you to execute code before or after calling the handler.
type NewHTMLRendererParams ¶
NewHTMLRendererParams holds the params needed to create HTMLRenderer
type NewHTMLRouterParams ¶
type NewHTMLRouterParams struct {
StaticDir StaticDir
RW *ReaderWriter
HTML *HTMLRenderer
AppConfig cconfig.Config
Logger clogger.Logger
}
NewHTMLRouterParams holds the params needed to instantiate a new HTMLRouter
type NewHandlerParams ¶
type NewHandlerParams struct {
Routers []Router
GlobalMiddlewares []Middleware
}
NewHandlerParams holds the params needed for NewHandler.
type NewServerParams ¶
type NewServerParams struct {
Handler http.Handler
Lifecycle *copper.Lifecycle
Config cconfig.Config
Logger clogger.Logger
}
NewServerParams holds the params needed to create a server.
type ReaderWriter ¶
type ReaderWriter struct {
// contains filtered or unexported fields
}
ReaderWriter provides functions to read data from HTTP requests and write response bodies in various formats
func NewReaderWriter ¶
func NewReaderWriter(renderer *HTMLRenderer, config cconfig.Config, logger clogger.Logger) *ReaderWriter
NewReaderWriter instantiates a new ReaderWriter with its dependencies
func (*ReaderWriter) ReadJSON ¶
func (rw *ReaderWriter) ReadJSON(w http.ResponseWriter, req *http.Request, body interface{}) bool
ReadJSON reads JSON from the http.Request into the body var. If the body struct has validate tags on it, the struct is also validated. If the validation fails, a BadRequest response is sent back and the function returns false.
func (*ReaderWriter) WriteHTML ¶
func (rw *ReaderWriter) WriteHTML(w http.ResponseWriter, r *http.Request, p WriteHTMLParams)
WriteHTML writes an HTML response to the provided http.ResponseWriter. Using the given WriteHTMLParams, the HTML is generated with a layout, page, and component templates.
func (*ReaderWriter) WriteHTMLError ¶
func (rw *ReaderWriter) WriteHTMLError(w http.ResponseWriter, r *http.Request, err error)
WriteHTMLError handles the given error. In dev environment, it writes an HTML page with the error. Errors are logged in all environments.
func (*ReaderWriter) WriteJSON ¶
func (rw *ReaderWriter) WriteJSON(w http.ResponseWriter, p WriteJSONParams)
WriteJSON writes a JSON response to the http.ResponseWriter. It can be configured with status code and data using WriteJSONParams.
type RequestLoggerMiddleware ¶
type RequestLoggerMiddleware struct {
// contains filtered or unexported fields
}
RequestLoggerMiddleware logs each request's HTTP method, path, and status code along with user uuid (from basic auth) if any.
func NewRequestLoggerMiddleware ¶
func NewRequestLoggerMiddleware(logger clogger.Logger) *RequestLoggerMiddleware
NewRequestLoggerMiddleware creates a new RequestLoggerMiddleware.
type Route ¶
type Route struct {
Middlewares []Middleware
Path string
Methods []string
Handler http.HandlerFunc
}
Route represents a single HTTP route (ex. /api/profile) that can be configured with middlewares, path, HTTP methods, and a handler.
type Router ¶
type Router interface {
Routes() []Route
}
Router is used to group routes together that are returned by the Routes method.
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
Server represents a configurable HTTP server that supports graceful shutdown.
type StaticDir ¶
StaticDir represents a directory that holds static resources (JS, CSS, images, etc.)
type WriteHTMLParams ¶
type WriteHTMLParams struct {
StatusCode int
Error error
Data interface{}
PageTemplate string
LayoutTemplate string
}
WriteHTMLParams holds the params for the WriteHTML function in ReaderWriter
type WriteJSONParams ¶
type WriteJSONParams struct {
StatusCode int
Data interface{}
}
WriteJSONParams holds the params for the WriteJSON function in ReaderWriter
Source Files
Directories