README
¶
aloja - little opinionated framework for plain http.Handlers
This framework provide convenience for the usual suspects when developing RESTful APIs or Web Applications.
It uses mainstream and common utilities and it is heavily opinionated with focus to alleviate repetitive tasks.
Features
In this release, we have:
- Fast routing (by way of httptreemux)
- Zero downtime restarts through endless
- Per request Context (provided by httpcontext)
- Middleware (gently managed by alice)
- Named params
- Serve static pages
- Serve http.Templates
- Some middleware: -- compression -- logs -- cors
Installation
go get github.com/jllopis/aloja
Quick sample
The framework lacks documentation. The use is something like this:
package main
import (
"fmt"
"net/http"
"testing"
"github.com/jllopis/aloja"
"github.com/jllopis/aloja/mw"
)
func indexHandler(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "Welcome!")
}
func sayHello(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "Hello little grasshoper!")
}
func sayHelloName(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "Hello %s!", aloja.Params(r).ByName("name"))
}
func main() {
// New server on port 8888
server := New().Port("8888")
// Use CORS Handler in every request
server.AddGlobal(mw.CorsHandler)
// Log every request
server.AddGlobal(mw.LogHandler)
// handler on main route
server.HandleFunc("GET", "/", indexHandler)
// Create a subrouter on branch /v1
r1 := server.NewSubrouter("/v1")
// Accept compression on this subrouter
r1.Use(mw.CompressHandler)
// Say hello!
r1.Get("/hello", http.HandlerFunc(sayHello))
// Say hello!
r1.Get("/hello/:name", http.HandlerFunc(sayHelloName))
// Run rabbit run!
server.Run()
}
Documentation
¶
Index ¶
- Constants
- type Aloja
- type ParamCol
- type Subrouter
- func (s *Subrouter) Delete(path string, handler http.Handler)
- func (s *Subrouter) Get(path string, handler http.Handler)
- func (s *Subrouter) Handle(method string, path string, h http.Handler)
- func (s *Subrouter) HandleFunc(method string, path string, f func(w http.ResponseWriter, r *http.Request))
- func (s *Subrouter) NewSubrouter(subpath string, middlewares ...mw.Middleware) *Subrouter
- func (s *Subrouter) Options(path string, handler http.Handler)
- func (s *Subrouter) Patch(path string, handler http.Handler)
- func (s *Subrouter) Post(path string, handler http.Handler)
- func (s *Subrouter) Put(path string, handler http.Handler)
- func (s *Subrouter) ServeStatic(rpath string, dir string)
- func (s *Subrouter) Use(m ...mw.Middleware)
- func (s *Subrouter) UseHandler(handler http.Handler)
Constants ¶
const (
VERSION = "v0.2.0"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Aloja ¶
type Aloja struct {
*Subrouter
// contains filtered or unexported fields
}
Aloja has the methods to abstract the work away. It provides a default Subrouter to carry on requests to '/'. You can coall NewSubrouter method on it to group routes and apply different middlewares to them
func New ¶
New creates a new Aloja with options. Accepted are: - Host - Port - SSLConf It exposes a global middleware that is called on every request, independently of the sobrouter configured if any
func (*Aloja) AddGlobal ¶
func (s *Aloja) AddGlobal(m ...mw.Middleware)
Add stacks a new middleware. It will be the last called. It accepts a list of middlewares and ordere is preserved left to right.
func (*Aloja) LoadTemplates ¶
type Subrouter ¶
func (*Subrouter) HandleFunc ¶
func (s *Subrouter) HandleFunc(method string, path string, f func(w http.ResponseWriter, r *http.Request))
HandleFunc serves an endpoint with the provided handler
func (*Subrouter) NewSubrouter ¶
func (s *Subrouter) NewSubrouter(subpath string, middlewares ...mw.Middleware) *Subrouter
func (*Subrouter) ServeStatic ¶
ServeStatic provides a quick way to serve static files
func (*Subrouter) Use ¶
func (s *Subrouter) Use(m ...mw.Middleware)
func (*Subrouter) UseHandler ¶ added in v0.2.0
UseHandler registers an http.Handler as a middleware.
Source Files
Directories