Meeseeks

Meeseek is lightweight and provides powerful http routing functionality

current meeseeks features

• you can have named parameters in your routes.
• you can provide Custom handlers for 404 Not Found and 405 Method Not Allowed responses.
• Sets an Allow header for all 405 Method Not Allowed responses.
• create and register middlewares to be used on all your routes
• Provide http.HandlerFunc functions as your path handlers and middlewares(straightfoward and easy)
• Zero dependencies.
• lightweight and gives you maximum control

Installation

$ go get github.com/Gwali-1/Meeseeks

Example Usage

package main

import (
    "fmt"
    "log"
    "net/http"
    " github.com/Gwali-1/Meeseeks"

func main() {
    // Initialize a new meeseeks router.
    router := meeseeks.NewMeeseeks()

    //register a handler function to handle get request on the /rocket/:name route
    //you can use : to denote a named path parameter
    //register handlers with route patterns using the http verb named methods on the meeseeks router (currently supports just GET and POST)
    router.GET("/rocket/:name", func(w http.ResponseWriter, r *http.Request) {
    // Using  meeseeks.LoadParam()  you can retrieve the path parameter specifed in you route with by passing
    //the request context and the parameter name
    // request context.
    name := meeseeks.LoadParam(r.Context(), "name")
    fmt.Fprintf(w, "rocket name is  %s", name)
})

    err := http.ListenAndServe(":2323", router)
    log.Fatal(err)
}

Using Middleware

 router := meeseeks.NewMeeseeks()

// The Use() method can be used to register middleware. Middleware registered
//on the router will be available on routes registered after the after the middle are regitration.
router.Use(exampleMiddleware1)
router.Use(exampleMiddleware2)
router.Use(exampleMiddleware3)
router.Use(exampleMiddleware4)

//middleware excution is bottom to top meaning exampleMiddleware4 is executed first in the middleware chain then
//exampleMiddleware3 and so on. This is useful if you need your middleware to execute in a particular order

Things To Note

• You can have conflicting routes such as (e.g. /posts/:id and posts/new). The order in which they are declared is how they are matched
• Trailing slashes are significant; /profile/:id and /profile/:id/ are not the same and won't match.
• An Allow header is automatically set for all 405 Method Not Allowed responses
• Middleware must be declared before a route in order for it to be used by that route. Any middleware declared after a route won't act on that route.
• For example:

router := meeseeks.NewMeeseeks()
router.Use(middleware1)
router.GET("/foo",foo) // This route will use middleware1 only.
router.Use(middleware2)
router.GET("/bar",bar)  // This route will use both middleware1 and middleware2.

Contributing

Feel free to send in any contributions (bug fixes, feature suggestions, etc)

Was motivated to write meeseeks after reading source code for alexedwards/flow

Todo

• in memory session store
• provide in-built middlewares for file serving
• middleware usage tests