Documentation ¶
Overview ¶
Package web is a lightweight web framework for Go. It's ideal for writing simple, performant backend web services.
Index ¶
- Variables
- func Close()
- func Delete(route string, handler interface{})
- func Get(route string, handler interface{})
- func Handle(route string, method string, httpHandler http.Handler)
- func Match(method string, route string, handler interface{})
- func NewCookie(name string, value string, age int64) *http.Cookie
- func Post(route string, handler interface{})
- func Process(c http.ResponseWriter, req *http.Request)
- func Put(route string, handler interface{})
- func Run(addr string)
- func RunFcgi(addr string)
- func RunScgi(addr string)
- func RunTLS(addr string, config *tls.Config)
- func SetLogger(logger *log.Logger)
- func Slug(s string, sep string) string
- func Urlencode(data map[string]string) string
- func Websocket(route string, httpHandler websocket.Handler)
- type Context
- func (ctx *Context) Abort(status int, body string)
- func (ctx *Context) BadRequest()
- func (ctx *Context) ContentType(val string) string
- func (ctx *Context) Forbidden()
- func (ctx *Context) GetBasicAuth() (string, string, error)
- func (ctx *Context) GetSecureCookie(name string) (string, bool)
- func (ctx *Context) NotFound(message string)
- func (ctx *Context) NotModified()
- func (ctx *Context) Redirect(status int, url_ string)
- func (ctx *Context) SetCookie(cookie *http.Cookie)
- func (ctx *Context) SetHeader(hdr string, val string, unique bool)
- func (ctx *Context) SetSecureCookie(name string, val string, age int64) error
- func (ctx *Context) Unauthorized()
- func (ctx *Context) WriteString(content string)
- type Server
- func (s *Server) Close()
- func (s *Server) Delete(route string, handler interface{})
- func (s *Server) Get(route string, handler interface{})
- func (s *Server) Handle(route string, method string, httpHandler http.Handler)
- func (s *Server) Match(method string, route string, handler interface{})
- func (s *Server) Post(route string, handler interface{})
- func (s *Server) Process(c http.ResponseWriter, req *http.Request)
- func (s *Server) Put(route string, handler interface{})
- func (s *Server) Run(addr string)
- func (s *Server) RunFcgi(addr string)
- func (s *Server) RunScgi(addr string)
- func (s *Server) RunTLS(addr string, config *tls.Config) error
- func (s *Server) ServeHTTP(c http.ResponseWriter, req *http.Request)
- func (s *Server) SetLogger(logger *log.Logger)
- func (s *Server) Websocket(route string, httpHandler websocket.Handler)
- type ServerConfig
Constants ¶
This section is empty.
Variables ¶
var ( ErrMissingCookieSecret = errors.New("Secret Key for secure cookies has not been set. Assign one to web.Config.CookieSecret.") ErrInvalidKey = errors.New("The keys for secure cookies have not been initialized. Ensure that a Run* method is being called") )
var Config = &ServerConfig{ RecoverPanic: true, ColorOutput: true, }
Config is the configuration of the main server.
Functions ¶
func Delete ¶
func Delete(route string, handler interface{})
Delete adds a handler for the 'DELETE' http method in the main server.
func Get ¶
func Get(route string, handler interface{})
Get adds a handler for the 'GET' http method in the main server.
func Handle ¶ added in v0.1.1
Add a custom http.Handler. Will have no effect when running as FCGI or SCGI.
func NewCookie ¶ added in v0.1.1
NewCookie is a helper method that returns a new http.Cookie object. Duration is specified in seconds. If the duration is zero, the cookie is permanent. This can be used in conjunction with ctx.SetCookie.
func Post ¶
func Post(route string, handler interface{})
Post adds a handler for the 'POST' http method in the main server.
func Process ¶ added in v0.1.1
func Process(c http.ResponseWriter, req *http.Request)
Process invokes the main server's routing system.
func Put ¶
func Put(route string, handler interface{})
Put adds a handler for the 'PUT' http method in the main server.
func Run ¶
func Run(addr string)
Run starts the web application and serves HTTP requests for the main server.
func RunFcgi ¶
func RunFcgi(addr string)
RunFcgi starts the web application and serves FastCGI requests for the main server.
func RunScgi ¶
func RunScgi(addr string)
RunScgi starts the web application and serves SCGI requests for the main server.
func RunTLS ¶ added in v0.1.1
RunTLS starts the web application and serves HTTPS requests for the main server.
func Slug ¶ added in v0.1.1
Slug is a helper function that returns the URL slug for string s. It's used to return clean, URL-friendly strings that can be used in routing.
Types ¶
type Context ¶
type Context struct { Request *http.Request Params map[string]string Server *Server http.ResponseWriter }
A Context object is created for every incoming HTTP request, and is passed to handlers as an optional first argument. It provides information about the request, including the http.Request object, the GET and POST params, and acts as a Writer for the response.
func (*Context) Abort ¶
Abort is a helper method that sends an HTTP header and an optional body. It is useful for returning 4xx or 5xx errors. Once it has been called, any return value from the handler will not be written to the response.
func (*Context) BadRequest ¶ added in v0.1.1
func (ctx *Context) BadRequest()
BadRequest writes a 400 HTTP response
func (*Context) ContentType ¶ added in v0.1.1
ContentType sets the Content-Type header for an HTTP response. For example, ctx.ContentType("json") sets the content-type to "application/json" If the supplied value contains a slash (/) it is set as the Content-Type verbatim. The return value is the content type as it was set, or an empty string if none was found.
func (*Context) Forbidden ¶ added in v0.1.1
func (ctx *Context) Forbidden()
Forbidden writes a 403 HTTP response
func (*Context) GetBasicAuth ¶ added in v0.1.1
GetBasicAuth returns the decoded user and password from the context's 'Authorization' header.
func (*Context) NotModified ¶ added in v0.1.1
func (ctx *Context) NotModified()
Notmodified writes a 304 HTTP response
func (*Context) SetHeader ¶ added in v0.1.1
SetHeader sets a response header. If `unique` is true, the current value of that header will be overwritten . If false, it will be appended.
func (*Context) SetSecureCookie ¶
func (*Context) Unauthorized ¶ added in v0.1.1
func (ctx *Context) Unauthorized()
Unauthorized writes a 401 HTTP response
func (*Context) WriteString ¶
WriteString writes string data into the response object.
type Server ¶ added in v0.1.1
type Server struct { Config *ServerConfig Logger *log.Logger Env map[string]interface{} // contains filtered or unexported fields }
Server represents a web.go server.
func (*Server) Delete ¶ added in v0.1.1
Delete adds a handler for the 'DELETE' http method for server s.
func (*Server) Handle ¶ added in v0.1.1
Add a custom http.Handler. Will have no effect when running as FCGI or SCGI.
func (*Server) Match ¶ added in v0.1.1
Match adds a handler for an arbitrary http method for server s.
func (*Server) Process ¶ added in v0.1.1
func (s *Server) Process(c http.ResponseWriter, req *http.Request)
Process invokes the routing system for server s
func (*Server) RunFcgi ¶ added in v0.1.1
RunFcgi starts the web application and serves FastCGI requests for s.
func (*Server) RunScgi ¶ added in v0.1.1
RunScgi starts the web application and serves SCGI requests for s.
func (*Server) RunTLS ¶ added in v0.1.1
RunTLS starts the web application and serves HTTPS requests for s.
func (*Server) ServeHTTP ¶ added in v0.1.1
func (s *Server) ServeHTTP(c http.ResponseWriter, req *http.Request)
ServeHTTP is the interface method for Go's http server package