Mainflux.mainflux/vendor/github.com/go-zoo/bone
Dušan Borovčanin caa4bda1a1
NOISSUE - Fix security warnings for dependencies (#1452)
* Fix security warnings for dependencies

Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com>

* Omit `.mod` and `.sum` files in dependencies

This feature is introduced here: https://tip.golang.org/doc/go1.17#vendor.

Signed-off-by: dusanb94 <dusan.borovcanin@mainflux.com>
2021-08-23 15:26:35 +02:00
..
.gitignore Migrate from dep to go modules (#971) 2019-11-27 15:29:34 +01:00
.travis.yml Migrate from dep to go modules (#971) 2019-11-27 15:29:34 +01:00
CHANGELOG.md Migrate from dep to go modules (#971) 2019-11-27 15:29:34 +01:00
CODE_OF_CONDUCT.md Migrate from dep to go modules (#971) 2019-11-27 15:29:34 +01:00
CONTRIBUTING.md Migrate from dep to go modules (#971) 2019-11-27 15:29:34 +01:00
LICENSE Integrate manager service 2017-09-23 01:03:27 +02:00
README.md Migrate from dep to go modules (#971) 2019-11-27 15:29:34 +01:00
bone.go Migrate from dep to go modules (#971) 2019-11-27 15:29:34 +01:00
helper.go Migrate from dep to go modules (#971) 2019-11-27 15:29:34 +01:00
helper_15.go Integrate manager service 2017-09-23 01:03:27 +02:00
helper_17.go Integrate manager service 2017-09-23 01:03:27 +02:00
mux.go Migrate from dep to go modules (#971) 2019-11-27 15:29:34 +01:00
route.go Migrate from dep to go modules (#971) 2019-11-27 15:29:34 +01:00
validator.go Migrate from dep to go modules (#971) 2019-11-27 15:29:34 +01:00

README.md

bone GoDoc Build Status Go Report Card

What is bone ?

Bone is a lightweight and lightning fast HTTP Multiplexer for Golang. It support :

  • URL Parameters
  • REGEX Parameters
  • Wildcard routes
  • Router Prefix
  • Route params validators
  • Sub Router, mux.SubRoute(), support most standard router (bone, gorilla/mux, httpRouter etc...)
  • Http method declaration
  • Support for http.Handler and http.HandlerFunc
  • Custom NotFound handler
  • Respect the Go standard http.Handler interface

alt tag

Speed

- BenchmarkBoneMux        10000000               118 ns/op
- BenchmarkZeusMux          100000               144 ns/op
- BenchmarkHttpRouterMux  10000000               134 ns/op
- BenchmarkNetHttpMux      3000000               580 ns/op
- BenchmarkGorillaMux       300000              3333 ns/op
- BenchmarkGorillaPatMux   1000000              1889 ns/op

These tests are just for fun, all these routers are great and efficient. Bone isn't the fastest router for every job.

Example


package main

import(
  "net/http"

  "github.com/go-zoo/bone"
)

func main () {
  mux := bone.New()

  mux.RegisterValidatorFunc("isNum", func(s string) bool {
    if _, err := strconv.Atoi(s); err == nil {
      return true
    }
    return false
  })

  // mux.Get, Post, etc ... takes http.Handler
  // validator for route parameter
  mux.Get("/home/:id|isNum", http.HandlerFunc(HomeHandler))
  // multiple parameter
  mux.Get("/profil/:id/:var", http.HandlerFunc(ProfilHandler))
  mux.Post("/data", http.HandlerFunc(DataHandler))

  // Support REGEX Route params
  mux.Get("/index/#id^[0-9]$", http.HandlerFunc(IndexHandler))

  // Handle take http.Handler
  mux.Handle("/", http.HandlerFunc(RootHandler))

  // GetFunc, PostFunc etc ... takes http.HandlerFunc
  mux.GetFunc("/test", Handler)

  http.ListenAndServe(":8080", mux)
}

func Handler(rw http.ResponseWriter, req *http.Request) {
  // Get the value of the "id" parameters.
  val := bone.GetValue(req, "id")

  rw.Write([]byte(val))
}

Blog Posts

Libs

  • Errors dump for Go : Trash
  • Middleware Chaining module : Claw