opirouter

opirouter

opinionated router

Features

• regex routes
• named url parameters
• handle each http method
• custom html include tags
• default final catch-all route
• lots of caching

Usage

package main

import (
	"fmt"
	"io"
	"net/http"

	"github.com/dougty/opirouter"
)

var router *opirouter.Router = opirouter.NewRouter()

func main() {
	router.GET("/test/:foo/:bar", testRoute)	
	http.ListenAndServe(":8888", router)
}

// http://localhost:8888/test/abc/123
func testRoute(w http.ResponseWriter, r *http.Request, p opirouter.Params) {
	io.WriteString(w, "hello browser\n")
	fmt.Println(p["foo"], p["bar"])
}

Static files

Static files can be served by passing http.FileServer to opirouter.Handle or opirouter.SetDefaultHandle

router.Handle("/assets", http.FileServer(http.Dir("./static")))
router.SetDefaultHandle(http.FileServer(http.Dir("./static")))

HTML Preprocessing

HTML files can be optionally preprocessed to parse custom include tags

router.EnableHTMLParser("./static")

• in the above example, all *.html files within the static dir will be preprocessed for includes
• <!-- include "foobar.html" --> in html will be replaced with the contents of ./static/foobar.html
• files are preprocessed once before serving to the browser and cached for subsequent requests
• includes can be nested as much as needed
• great for Vue component templates!

Disable caching

Caching can be disabled for development purposes with the env var NOCACHE=1