chi

README

Mir.Chi

Mir.Chi module provide mir.Engine implement backend by Chi.

Usage

package main

import(
	"github.com/alimy/mir"
	"github.com/go-chi/chi"
	"log"
	"net/http"
	
	mirE "github.com/alimy/mir/module/chi"
)

type site struct {
	count    uint32
	
	Group mir.Group     `mir:"v1"`
	index mir.Get       `mir:"/index/"`
	articles mir.Get    `mir:"/articles/{category}/{id:[0-9]+}#GetArticles"`
}

// Index handler of the index field that in site struct, the struct tag indicate
// this handler will register to path "/index/" and method is http.MethodGet.
func (h *site) Index(rw http.ResponseWriter, r *http.Request) {
	h.count++
	rw.Write([]byte("Index"))
}

// GetArticles handler of articles indicator that contains Host/Path/Queries/Handler info.
// Path info is the second or first(if no host info) segment start with '/'(eg: /articles/{category}/{id:[0-9]+}/
// Handler info is forth info start with '#' that indicate real handler method name(eg: GetArticles).
// if no handler info will use field name capital first char as default handler name(eg: if articles had
// no #GetArticles then the handler name will is Articles) 
func (h *site) GetArticles(rw http.ResponseWriter, r *http.Request) {
	rw.Write([]byte("GetArticles"))
}

func main() {
	// Create a new mux router instance
	r := chi.NewRouter()
	
	// Instance a mir engine to register handler for mux router by mir
	mirE.Register(r, &site{}) 
	
	// Bind to a port and pass our router in
	log.Fatal(http.ListenAndServe(":8013", r)) 
}

Documentation

Index

• func Mir(r chi.Router) mir.Engine
• func Register(r chi.Router, entries ...interface{}) error

Functions

func Mir

func Mir(r chi.Router) mir.Engine

Mir return mir.Engine interface implements instance. Used to register routes to Chi router with struct tag string's information.

func Register

func Register(r chi.Router, entries ...interface{}) error

Register use entries's info to register handler to Chi router.