Documentation ¶
Index ¶
- Variables
- func MethodOverride(res http.ResponseWriter, req *http.Request)
- func NotFoundHandler(status int, err error, c Context) error
- func RegisterBinder(contentType string, fn BinderFunc)
- type App
- func (a *App) ANY(p string, h Handler)
- func (a *App) DELETE(p string, h Handler) *RouteInfo
- func (a *App) GET(p string, h Handler) *RouteInfo
- func (a *App) Group(groupPath string) *App
- func (a *App) HEAD(p string, h Handler) *RouteInfo
- func (a *App) OPTIONS(p string, h Handler) *RouteInfo
- func (a *App) PATCH(p string, h Handler) *RouteInfo
- func (a *App) POST(p string, h Handler) *RouteInfo
- func (a *App) PUT(p string, h Handler) *RouteInfo
- func (a *App) PanicHandler(next Handler) Handler
- func (a *App) Redirect(status int, from, to string) *RouteInfo
- func (a *App) Resource(p string, r Resource) *App
- func (a *App) Routes() RouteList
- func (a *App) ServeFiles(p string, root http.FileSystem)
- func (a *App) ServeHTTP(w http.ResponseWriter, r *http.Request)
- func (a *App) Use(mw ...MiddlewareFunc)
- type BaseResource
- func (v *BaseResource) Create(c Context) error
- func (v *BaseResource) Destroy(c Context) error
- func (v *BaseResource) Edit(c Context) error
- func (v *BaseResource) List(c Context) error
- func (v *BaseResource) New(c Context) error
- func (v *BaseResource) Show(c Context) error
- func (v *BaseResource) Update(c Context) error
- type BinderFunc
- type Context
- type DefaultContext
- func (d *DefaultContext) Bind(value interface{}) error
- func (d *DefaultContext) Data() map[string]interface{}
- func (d *DefaultContext) Error(status int, err error) error
- func (d *DefaultContext) Flash() *Flash
- func (d *DefaultContext) Get(key string) interface{}
- func (d *DefaultContext) LogField(key string, value interface{})
- func (d *DefaultContext) LogFields(values map[string]interface{})
- func (d *DefaultContext) Logger() Logger
- func (d *DefaultContext) Param(key string) string
- func (d *DefaultContext) ParamInt(key string) (int, error)
- func (d *DefaultContext) Params() ParamValues
- func (d *DefaultContext) Redirect(status int, url string, args ...interface{}) error
- func (d *DefaultContext) Render(status int, rr render.Renderer) error
- func (d *DefaultContext) Request() *http.Request
- func (d *DefaultContext) Response() http.ResponseWriter
- func (d *DefaultContext) Session() *Session
- func (d *DefaultContext) Set(key string, value interface{})
- func (d *DefaultContext) Value(key interface{}) interface{}
- func (d *DefaultContext) Websocket() (*websocket.Conn, error)
- type ErrorHandler
- type ErrorHandlers
- type Flash
- type HTTPError
- type Handler
- type Logger
- type MiddlewareFunc
- type MiddlewareStack
- type Options
- type ParamValues
- type Resource
- type RouteHelperFunc
- type RouteInfo
- type RouteList
- type Session
Constants ¶
This section is empty.
Variables ¶
var RequestLogger = RequestLoggerFunc
RequestLogger can be be overridden to a user specified function that can be used to log the request.
Functions ¶
func MethodOverride ¶
func MethodOverride(res http.ResponseWriter, req *http.Request)
MethodOverride is the default implementation for the Options#MethodOverride. By default it will look for a form value name `_method` and change the request method if that is present and the original request is of type "POST". This is added automatically when using `Automatic` Buffalo, unless an alternative is defined in the Options.
func NotFoundHandler ¶ added in v0.7.1
NotFoundHandler is the default ErrorHandler for 404 responses. In development mode it attempts to return useful debugging information. In production it defaults to use the http.NotFound handler.
func RegisterBinder ¶ added in v0.7.3
func RegisterBinder(contentType string, fn BinderFunc)
RegisterBinder maps a request Content-Type (application/json) to a BinderFunc.
Types ¶
type App ¶
type App struct { Options // Middleware returns the current MiddlewareStack for the App/Group. Middleware *MiddlewareStack ErrorHandlers ErrorHandlers // contains filtered or unexported fields }
App is where it all happens! It holds on to options, the underlying router, the middleware, and more. Without an App you can't do much!
func Automatic ¶
Automatic returns a new instance of App with sane defaults, some not so sane defaults, and a few bits and pieces to make your life that much easier. You'll want to use this almost all of the time to build your applications.
func New ¶
New returns a new instance of App, without any frills or thrills. Most people will want to use Automatic which adds some sane, and useful, defaults.
func (*App) ANY ¶
ANY accepts a request across any HTTP method for the specified path and routes it to the specified Handler.
func (*App) Group ¶
Group creates a new `*App` that inherits from it's parent `*App`. This is useful for creating groups of end-points that need to share common functionality, like middleware.
g := a.Group("/api/v1") g.Use(AuthorizeAPIMiddleware) g.GET("/users, APIUsersHandler) g.GET("/users/:user_id, APIUserShowHandler)
func (*App) PanicHandler ¶ added in v0.8.2
PanicHandler recovers from panics gracefully and calls the error handling code for a 500 error.
func (*App) Redirect ¶ added in v0.7.3
Redirect from one URL to another URL. Only works for "GET" requests.
func (*App) Resource ¶ added in v0.4.3
Resource maps an implementation of the Resource interface to the appropriate RESTful mappings. Resource returns the *App associated with this group of mappings so you can set middleware, etc... on that group, just as if you had used the a.Group functionality.
a.Resource("/users", &UsersResource{}) // Is equal to this: ur := &UsersResource{} g := a.Group("/users") g.GET("/", ur.List) // GET /users => ur.List g.GET("/new", ur.New) // GET /users/new => ur.New g.GET("/{user_id}", ur.Show) // GET /users/{user_id} => ur.Show g.GET("/{user_id}/edit", ur.Edit) // GET /users/{user_id}/edit => ur.Edit g.POST("/", ur.Create) // POST /users => ur.Create g.PUT("/{user_id}", ur.Update) PUT /users/{user_id} => ur.Update g.DELETE("/{user_id}", ur.Destroy) DELETE /users/{user_id} => ur.Destroy
func (*App) ServeFiles ¶
func (a *App) ServeFiles(p string, root http.FileSystem)
ServeFiles maps an path to a directory on disk to serve static files. Useful for JavaScript, images, CSS, etc...
a.ServeFiles("/assets", http.Dir("path/to/assets"))
func (*App) Use ¶
func (a *App) Use(mw ...MiddlewareFunc)
Use the specified Middleware for the App. When defined on an `*App` the specified middleware will be inherited by any `Group` calls that are made on that on the App.
type BaseResource ¶ added in v0.4.3
type BaseResource struct{}
BaseResource fills in the gaps for any Resource interface functions you don't want/need to implement.
type UsersResource struct { Resource } func (ur *UsersResource) List(c Context) error { return c.Render(200, render.String("hello") } // This will fulfill the Resource interface, despite only having // one of the functions defined. &UsersResource{&BaseResource{})
func (*BaseResource) Create ¶ added in v0.4.3
func (v *BaseResource) Create(c Context) error
Create default implementation. Returns a 404
func (*BaseResource) Destroy ¶ added in v0.4.3
func (v *BaseResource) Destroy(c Context) error
Destroy default implementation. Returns a 404
func (*BaseResource) Edit ¶ added in v0.4.3
func (v *BaseResource) Edit(c Context) error
Edit default implementation. Returns a 404
func (*BaseResource) List ¶ added in v0.4.3
func (v *BaseResource) List(c Context) error
List default implementation. Returns a 404
func (*BaseResource) New ¶ added in v0.4.3
func (v *BaseResource) New(c Context) error
New default implementation. Returns a 404
func (*BaseResource) Show ¶ added in v0.4.3
func (v *BaseResource) Show(c Context) error
Show default implementation. Returns a 404
func (*BaseResource) Update ¶ added in v0.4.3
func (v *BaseResource) Update(c Context) error
Update default implementation. Returns a 404
type BinderFunc ¶ added in v0.7.3
BinderFunc takes a request and binds it to an interface. If there is a problem it should return an error.
type Context ¶
type Context interface { context.Context Response() http.ResponseWriter Request() *http.Request Session() *Session Params() ParamValues Param(string) string ParamInt(string) (int, error) Set(string, interface{}) Get(string) interface{} LogField(string, interface{}) LogFields(map[string]interface{}) Logger() Logger Bind(interface{}) error Render(int, render.Renderer) error Error(int, error) error Websocket() (*websocket.Conn, error) Redirect(int, string, ...interface{}) error Data() map[string]interface{} Flash() *Flash }
Context holds on to information as you pass it down through middleware, Handlers, templates, etc... It strives to make your life a happier one.
type DefaultContext ¶
DefaultContext is, as its name implies, a default implementation of the Context interface.
func (*DefaultContext) Bind ¶
func (d *DefaultContext) Bind(value interface{}) error
Bind the interface to the request.Body. The type of binding is dependent on the "Content-Type" for the request. If the type is "application/json" it will use "json.NewDecoder". If the type is "application/xml" it will use "xml.NewDecoder". The default binder is "http://www.gorillatoolkit.org/pkg/schema".
func (*DefaultContext) Data ¶
func (d *DefaultContext) Data() map[string]interface{}
Data contains all the values set through Get/Set.
func (*DefaultContext) Flash ¶ added in v0.7.2
func (d *DefaultContext) Flash() *Flash
Flash messages for the associated Request.
func (*DefaultContext) Get ¶
func (d *DefaultContext) Get(key string) interface{}
Get is deprecated. Please use Value instead.
func (*DefaultContext) LogField ¶
func (d *DefaultContext) LogField(key string, value interface{})
LogField adds the key/value pair onto the Logger to be printed out as part of the request logging. This allows you to easily add things like metrics (think DB times) to your request.
func (*DefaultContext) LogFields ¶
func (d *DefaultContext) LogFields(values map[string]interface{})
LogFields adds the key/value pairs onto the Logger to be printed out as part of the request logging. This allows you to easily add things like metrics (think DB times) to your request.
func (*DefaultContext) Logger ¶
func (d *DefaultContext) Logger() Logger
Logger returns the Logger for this context.
func (*DefaultContext) Param ¶
func (d *DefaultContext) Param(key string) string
Param returns a param, either named or query string, based on the key.
func (*DefaultContext) ParamInt ¶
func (d *DefaultContext) ParamInt(key string) (int, error)
ParamInt tries to convert the requested parameter to an int. It will return an error if there is a problem.
func (*DefaultContext) Params ¶
func (d *DefaultContext) Params() ParamValues
Params returns all of the parameters for the request, including both named params and query string parameters.
func (*DefaultContext) Redirect ¶
func (d *DefaultContext) Redirect(status int, url string, args ...interface{}) error
Redirect a request with the given status to the given URL.
func (*DefaultContext) Render ¶
func (d *DefaultContext) Render(status int, rr render.Renderer) error
Render a status code and render.Renderer to the associated Response. The request parameters will be made available to the render.Renderer "{{.params}}". Any values set onto the Context will also automatically be made available to the render.Renderer. To render "no content" pass in a nil render.Renderer.
func (*DefaultContext) Request ¶
func (d *DefaultContext) Request() *http.Request
Request returns the original Request.
func (*DefaultContext) Response ¶
func (d *DefaultContext) Response() http.ResponseWriter
Response returns the original Response for the request.
func (*DefaultContext) Session ¶
func (d *DefaultContext) Session() *Session
Session for the associated Request.
func (*DefaultContext) Set ¶
func (d *DefaultContext) Set(key string, value interface{})
Set a value onto the Context. Any value set onto the Context will be automatically available in templates.
func (*DefaultContext) Value ¶ added in v0.7.2
func (d *DefaultContext) Value(key interface{}) interface{}
Value that has previously stored on the context.
type ErrorHandler ¶ added in v0.7.1
ErrorHandler interface for handling an error for a specific status code.
type ErrorHandlers ¶ added in v0.7.1
type ErrorHandlers map[int]ErrorHandler
ErrorHandlers is used to hold a list of ErrorHandler types that can be used to handle specific status codes.
a.ErrorHandlers[500] = func(status int, err error, c buffalo.Context) error { res := c.Response() res.WriteHeader(status) res.Write([]byte(err.Error())) return nil }
func (ErrorHandlers) Get ¶ added in v0.7.1
func (e ErrorHandlers) Get(status int) ErrorHandler
Get a registered ErrorHandler for this status code. If no ErrorHandler has been registered, a default one will be returned.
type Flash ¶ added in v0.7.2
type Flash struct {
// contains filtered or unexported fields
}
Flash is a struct that helps with the operations over flash messages.
func (Flash) Add ¶ added in v0.7.2
Add adds a flash value for a flash key, if the key already has values the list for that value grows.
func (*Flash) Clear ¶ added in v0.7.2
func (f *Flash) Clear()
Clear removes all keys from the Flash.
type HTTPError ¶ added in v0.7.2
HTTPError a typed error returned by http Handlers and used for choosing error handlers
type Handler ¶
Handler is the basis for all of Buffalo. A Handler will be given a Context interface that represents the give request/response. It is the responsibility of the Handler to handle the request/response correctly. This could mean rendering a template, JSON, etc... or it could mean returning an error.
func (c Context) error { return c.Render(200, render.String("Hello World!")) } func (c Context) error { return c.Redirect(301, "http://github.com/gobuffalo/buffalo") } func (c Context) error { return c.Error(422, errors.New("oops!!")) }
func RequestLoggerFunc ¶
RequestLoggerFunc is the default implementation of the RequestLogger. By default it will log a uniq "request_id", the HTTP Method of the request, the path that was requested, the duration (time) it took to process the request, the size of the response (and the "human" size), and the status code of the response.
func WrapHandler ¶
WrapHandler wraps a standard http.Handler and transforms it into a buffalo.Handler.
func WrapHandlerFunc ¶
func WrapHandlerFunc(h http.HandlerFunc) Handler
WrapHandlerFunc wraps a standard http.HandlerFunc and transforms it into a buffalo.Handler.
type Logger ¶
type Logger interface { WithField(string, interface{}) Logger WithFields(map[string]interface{}) Logger Debugf(string, ...interface{}) Infof(string, ...interface{}) Printf(string, ...interface{}) Warnf(string, ...interface{}) Errorf(string, ...interface{}) Fatalf(string, ...interface{}) Debug(...interface{}) Info(...interface{}) Warn(...interface{}) Error(...interface{}) Fatal(...interface{}) Panic(...interface{}) }
Logger interface is used throughout Buffalo apps to log a whole manner of things.
func NewLogger ¶
NewLogger based on the specified log level. This logger will log to the STDOUT in a human readable, but parseable form.
Example: time="2016-12-01T21:02:07-05:00" level=info duration=225.283µs human_size="106 B" method=GET path="/" render=199.79µs request_id=2265736089 size=106 status=200
type MiddlewareFunc ¶
MiddlewareFunc defines the interface for a piece of Buffalo Middleware.
func DoSomething(next Handler) Handler { return func(c Context) error { // do something before calling the next handler err := next(c) // do something after call the handler return err } }
type MiddlewareStack ¶
type MiddlewareStack struct {
// contains filtered or unexported fields
}
MiddlewareStack manages the middleware stack for an App/Group.
func (*MiddlewareStack) Clear ¶
func (ms *MiddlewareStack) Clear()
Clear wipes out the current middleware stack for the App/Group, any middleware previously defined will be removed leaving an empty middleware stack.
func (*MiddlewareStack) Replace ¶ added in v0.5.0
func (ms *MiddlewareStack) Replace(mw1 MiddlewareFunc, mw2 MiddlewareFunc)
Replace a piece of middleware with another piece of middleware. Great for testing.
func (*MiddlewareStack) Skip ¶
func (ms *MiddlewareStack) Skip(mw MiddlewareFunc, handlers ...Handler)
Skip a specified piece of middleware the specified Handlers. This is useful for things like wrapping your application in an authorization middleare, but skipping it for things the home page, the login page, etc...
a.Middleware.Skip(Authorization, HomeHandler, LoginHandler, RegistrationHandler)
NOTE: When skipping Resource handlers, you need to first declare your resource handler as a type of buffalo.Resource for the Skip function to properly recognize and match it.
// Works: var ur Resource cr = &carsResource{&buffaloBaseResource{}} g = a.Resource("/cars", cr) g.Use(SomeMiddleware) g.Middleware.Skip(SomeMiddleware, cr.Show) // Doesn't Work: cr := &carsResource{&buffaloBaseResource{}} g = a.Resource("/cars", cr) g.Use(SomeMiddleware) g.Middleware.Skip(SomeMiddleware, cr.Show)
func (*MiddlewareStack) Use ¶
func (ms *MiddlewareStack) Use(mw ...MiddlewareFunc)
Use the specified Middleware for the App. When defined on an `*App` the specified middleware will be inherited by any `Group` calls that are made on that on the App.
type Options ¶
type Options struct { // Env is the "environment" in which the App is running. Default is "development". Env string // LogLevel defaults to "debug". LogLevel string // Logger to be used with the application. A default one is provided. Logger Logger // MethodOverride allows for changing of the request method type. See the default // implementation at buffalo.MethodOverride MethodOverride http.HandlerFunc // SessionStore is the `github.com/gorilla/sessions` store used to back // the session. It defaults to use a cookie store and the ENV variable // `SESSION_SECRET`. SessionStore sessions.Store // SessionName is the name of the session cookie that is set. This defaults // to "_buffalo_session". SessionName string // Host that this application will be available at. Default is "http://127.0.0.1:[$PORT|3000]". Host string // contains filtered or unexported fields }
Options are used to configure and define how your application should run.
func NewOptions ¶
func NewOptions() Options
NewOptions returns a new Options instance with sensible defaults
type ParamValues ¶
ParamValues will most commonly be url.Values, but isn't it great that you set your own? :)
type Resource ¶ added in v0.4.3
type Resource interface { List(Context) error Show(Context) error New(Context) error Create(Context) error Edit(Context) error Update(Context) error Destroy(Context) error }
Resource interface allows for the easy mapping of common RESTful actions to a set of paths. See the a.Resource documentation for more details. NOTE: When skipping Resource handlers, you need to first declare your resource handler as a type of buffalo.Resource for the Skip function to properly recognize and match it.
// Works: var cr Resource cr = &carsResource{&buffaloBaseResource{}} g = a.Resource("/cars", cr) g.Use(SomeMiddleware) g.Middleware.Skip(SomeMiddleware, cr.Show) // Doesn't Work: cr := &carsResource{&buffaloBaseResource{}} g = a.Resource("/cars", cr) g.Use(SomeMiddleware) g.Middleware.Skip(SomeMiddleware, cr.Show)
type RouteHelperFunc ¶ added in v0.8.2
RouteHelperFunc represents the function that takes the route and the opts and build the path
type RouteInfo ¶ added in v0.7.1
type RouteInfo struct { Method string `json:"method"` Path string `json:"path"` HandlerName string `json:"handler"` MuxRoute *mux.Route `json:"-"` Handler Handler `json:"-"` PathName string `json:"pathName"` App *App `json:"-"` }
RouteInfo provides information about the underlying route that was built.
func (*RouteInfo) BuildPathHelper ¶ added in v0.8.2
func (ri *RouteInfo) BuildPathHelper() RouteHelperFunc
BuildPathHelper Builds a routeHelperfunc for a particular RouteInfo
type RouteList ¶
type RouteList []RouteInfo
RouteList contains a mapping of the routes defined in the application. This listing contains, Method, Path, and the name of the Handler defined to process that route.
type Session ¶
Session wraps the "github.com/gorilla/sessions" API in something a little cleaner and a bit more useable.
func (*Session) Delete ¶
func (s *Session) Delete(name interface{})
Delete a value from the current session.