polaris

README

polaris

a restful web framework like tornado written by go

see my chinese blog for more

Example

type Handler1 struct {

}

func (h *Handler1) Prepare(env *Env) {
    fmt.Println("hello prepare")
}

func (h *Handler1) Get(env *Env) {
    env.WriteString("hello world")
}

type Handler2 struct {

}

//id is a captured submatch for regexp url below
func (h *Handler2) Get(env *Env, id string) {
    env.WriteString("hello " + id)
}

app := NewApp(configFile)

app.Handle("/handler1", new(Handler1))
app.Handle("/handler2/([0-9]+)", new(Handler2))

app.Run()

Dependence

go get github.com/garyburd/redigo/redis

Documentation

Index

• Variables
• type App
  • func NewApp(configFile string) (*App, error)
  • func (app *App) Config() *Config
  • func (app *App) Handle(pattern string, handler interface{}) error
  • func (app *App) Run() error
• type Config
  • func ParserConfig(configFile string) (*Config, error)

Variables

var (
	ErrAppRunning = errors.New("app is running, cannot set")
)

var SupportMethods = []string{"Prepare", "Get", "Post", "Put", "Head", "Delete"}

Types

type App

type App struct {
	// contains filtered or unexported fields
}

func NewApp

func NewApp(configFile string) (*App, error)

func (*App) Config

func (app *App) Config() *Config

func (*App) Handle

func (app *App) Handle(pattern string, handler interface{}) error

func (*App) Run

func (app *App) Run() error

type Config

type Config struct {
	//polaris listen addr
	HttpAddr string `json:"http_addr"`

	Middlewares []struct {
		Name   string          `json:"name"`
		Config json.RawMessage `json:"config"`
	} `json:"middlewares"`
}

func ParserConfig

func ParserConfig(configFile string) (*Config, error)