This project is used by many folks
35 |Are you using this project?
38 | 39 | Add your company 40 | 41 |This project is maintained by a dedicated group of people.
59 |
11 |
12 | Go Server/API micro framework, HTTP request router, multiplexer, mux.
13 |
14 | 📖 ABOUT
15 | ==================================================
16 | Contributors:
17 |
18 | * [Rafał Lorenz](https://rafallorenz.com)
19 |
20 | Want to contribute ? Feel free to send pull requests!
21 |
22 | Have problems, bugs, feature ideas?
23 | We are using the github [issue tracker](https://github.com/vardius/gorouter/issues) to manage them.
24 |
25 | ## 📚 Documentation
26 |
27 | For **documentation** (_including examples_), **visit [rafallorenz.com/gorouter](https://rafallorenz.com/gorouter)**
28 |
29 | For **GoDoc** reference, **visit [pkg.go.dev](https://pkg.go.dev/github.com/vardius/gorouter)**
30 |
31 | ## 🚅 Benchmark
32 |
33 | ```go
34 | ➜ gorouter git:(master) ✗ go test -bench=. -cpu=4 -benchmem
35 | test
36 | goos: darwin
37 | goarch: amd64
38 | pkg: github.com/vardius/gorouter/v4
39 | BenchmarkNetHTTP-4 65005786 17.9 ns/op 0 B/op 0 allocs/op
40 | BenchmarkFastHTTP-4 69810878 16.5 ns/op 0 B/op 0 allocs/op
41 | PASS
42 | ok github.com/vardius/gorouter/v4 3.808s
43 | ```
44 |
45 | 👉 **[Click here](https://rafallorenz.com/gorouter/docs/benchmark)** to see all benchmark results.
46 |
47 | ## Features
48 | - Routing System
49 | - Middleware System
50 | - Authentication
51 | - Fast HTTP
52 | - Serving Files
53 | - Multidomain
54 | - HTTP2 Support
55 | - Low memory usage
56 | - [Documentation](https://rafallorenz.com/gorouter/)
57 |
58 | 🚏 HOW TO USE
59 | ==================================================
60 |
61 | - [Basic example](https://rafallorenz.com/gorouter/docs/basic-example)
62 | - [net/http](https://rafallorenz.com/gorouter/docs/basic-example#nethttp)
63 | - [valyala/fasthttp](https://rafallorenz.com/gorouter/docs/basic-example#fasthttp)
64 |
65 | ## 🖥️ API example setup
66 |
67 | - **[Go Server/API boilerplate](https://github.com/vardius/go-api-boilerplate)** using best practices DDD CQRS ES.
68 |
69 | 📜 [License](LICENSE.md)
70 | -------
71 |
72 | This package is released under the MIT license. See the complete license in the package:
73 |
74 | [](https://app.fossa.io/projects/git%2Bgithub.com%2Fvardius%2Fgorouter?ref=badge_large)
75 |
--------------------------------------------------------------------------------
/.github/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6 |
7 | ## Our Standards
8 |
9 | Examples of behavior that contributes to creating a positive environment include:
10 |
11 | * Using welcoming and inclusive language
12 | * Being respectful of differing viewpoints and experiences
13 | * Gracefully accepting constructive criticism
14 | * Focusing on what is best for the community
15 | * Showing empathy towards other community members
16 |
17 | Examples of unacceptable behavior by participants include:
18 |
19 | * The use of sexualized language or imagery and unwelcome sexual attention or advances
20 | * Trolling, insulting/derogatory comments, and personal or political attacks
21 | * Public or private harassment
22 | * Publishing others' private information, such as a physical or electronic address, without explicit permission
23 | * Other conduct which could reasonably be considered inappropriate in a professional setting
24 |
25 | ## Our Responsibilities
26 |
27 | Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28 |
29 | Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30 |
31 | ## Scope
32 |
33 | This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34 |
35 | ## Enforcement
36 |
37 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at vardius@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38 |
39 | Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40 |
41 | ## Attribution
42 |
43 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44 |
45 | [homepage]: http://contributor-covenant.org
46 | [version]: http://contributor-covenant.org/version/1/4/
47 |
--------------------------------------------------------------------------------
/website/docs/basic-authentication.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: basic-authentication
3 | title: Basic Authentication
4 | sidebar_label: Basic Authentication
5 | ---
6 |
7 | ## Basic Authentication
8 |
9 |
10 |
11 | ```go
12 | package main
13 |
14 | import (
15 | "fmt"
16 | "log"
17 | "net/http"
18 | "crypto/subtle"
19 |
20 | "github.com/vardius/gorouter/v4"
21 | )
22 |
23 | var (
24 | requiredUser = []byte("gordon")
25 | requiredPassword = []byte("secret!")
26 | )
27 |
28 | func BasicAuth(next http.Handler) http.Handler {
29 | fn := func(w http.ResponseWriter, r *http.Request) {
30 | // Get the Basic Authentication credentials
31 | user, password, hasAuth := r.BasicAuth()
32 |
33 | if !hasAuth || subtle.ConstantTimeCompare(requiredUser, []byte(user)) != 1 || subtle.ConstantTimeCompare(requiredPassword, []byte(password)) != 1 {
34 | w.Header().Set("WWW-Authenticate", "Basic realm=Restricted")
35 | http.Error(w, http.StatusText(http.StatusUnauthorized), http.StatusUnauthorized)
36 | return
37 | }
38 |
39 | next.ServeHTTP(w, r)
40 | }
41 |
42 | return http.HandlerFunc(fn)
43 | }
44 |
45 | func index(w http.ResponseWriter, r *http.Request) {
46 | fmt.Fprint(w, "Not protected!\n")
47 | }
48 |
49 | func protected(w http.ResponseWriter, r *http.Request) {
50 | fmt.Fprint(w, "Protected!\n")
51 | }
52 |
53 | func main() {
54 | router := gorouter.New()
55 | router.GET("/", http.HandlerFunc(index))
56 | router.GET("/protected", http.HandlerFunc(protected))
57 |
58 | router.USE("GET", "/protected", BasicAuth)
59 |
60 | log.Fatal(http.ListenAndServe(":8080", router))
61 | }
62 | ```
63 |
64 | ```go
65 | package main
66 |
67 | import (
68 | "crypto/subtle"
69 | "bytes"
70 | "encoding/base64"
71 | "fmt"
72 | "log"
73 |
74 | "github.com/valyala/fasthttp"
75 | "github.com/vardius/gorouter/v4"
76 | )
77 |
78 | var (
79 | basicAuthPrefix = []byte("Basic ")
80 | requiredUser = []byte("gordon")
81 | requiredPassword = []byte("secret!")
82 | )
83 |
84 | func BasicAuth(next fasthttp.RequestHandler) fasthttp.RequestHandler {
85 | fn := func(ctx *fasthttp.RequestCtx) {
86 | // Get the Basic Authentication credentials
87 | auth := ctx.Request.Header.Peek("Authorization")
88 | if bytes.HasPrefix(auth, basicAuthPrefix) {
89 | // Check credentials
90 | payload, err := base64.StdEncoding.DecodeString(string(auth[len(basicAuthPrefix):]))
91 | if err == nil {
92 | pair := bytes.SplitN(payload, []byte(":"), 2)
93 | if len(pair) == 2 && subtle.ConstantTimeCompare(requiredUser, pair[0]) == 1 && subtle.ConstantTimeCompare(requiredPassword, pair[1]) == 1 {
94 | // Delegate request to the given handle
95 | next(ctx)
96 | return
97 | }
98 | }
99 | }
100 |
101 | // Request Basic Authentication otherwise
102 | ctx.Response.Header.Set("WWW-Authenticate", "Basic realm=Restricted")
103 | ctx.Error(fasthttp.StatusMessage(fasthttp.StatusUnauthorized), fasthttp.StatusUnauthorized)
104 | }
105 |
106 | return fn
107 | }
108 |
109 | func index(_ *fasthttp.RequestCtx) {
110 | fmt.Print("Not Protected!\n")
111 | }
112 |
113 | func protected(_ *fasthttp.RequestCtx) {
114 | fmt.Print("Protected!\n")
115 | }
116 |
117 | func main() {
118 | router := gorouter.NewFastHTTPRouter()
119 | router.GET("/", index)
120 | router.GET("/protected", protected)
121 |
122 | router.USE("GET", "/protected", BasicAuth)
123 |
124 | log.Fatal(fasthttp.ListenAndServe(":8080", router.HandleFastHTTP))
125 | }
126 | ```
127 |
128 |
--------------------------------------------------------------------------------
/website/src/core/Footer.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright (c) 2017-present, Facebook, Inc.
3 | *
4 | * This source code is licensed under the MIT license found in the
5 | * LICENSE file in the root directory of this source tree.
6 | */
7 |
8 | const React = require("react");
9 |
10 | class Footer extends React.Component {
11 | docUrl(doc, language) {
12 | const baseUrl = this.props.config.baseUrl;
13 | const docsUrl = this.props.config.docsUrl;
14 | const docsPart = `${docsUrl ? `${docsUrl}/` : ""}`;
15 | const langPart = `${language ? `${language}/` : ""}`;
16 | return `${baseUrl}${docsPart}${langPart}${doc}`;
17 | }
18 |
19 | pageUrl(doc, language) {
20 | const baseUrl = this.props.config.baseUrl;
21 | return baseUrl + (language ? `${language}/` : "") + doc;
22 | }
23 |
24 | render() {
25 | return (
26 |
96 | );
97 | }
98 | }
99 |
100 | module.exports = Footer;
101 |
--------------------------------------------------------------------------------
/website/docs/multidomain.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: multidomain
3 | title: Multidomain
4 | sidebar_label: Multidomain
5 | ---
6 |
7 | ## HostSwitch
8 |
9 |
10 |
11 | ```go
12 | import (
13 | "fmt"
14 | "log"
15 | "net/http"
16 |
17 | "github.com/vardius/gorouter/v4"
18 | "github.com/vardius/gorouter/v4/context"
19 | )
20 |
21 | // We need an object that implements the http.Handler interface.
22 | // Therefore we need a type for which we implement the ServeHTTP method.
23 | // We just use a map here, in which we map host names (with port) to http.Handlers
24 | type HostSwitch map[string]http.Handler
25 |
26 | // Implement the ServerHTTP method on our new type
27 | func (hs HostSwitch) ServeHTTP(w http.ResponseWriter, r *http.Request) {
28 | // Check if a http.Handler is registered for the given host.
29 | // If yes, use it to handle the request.
30 | if handler := hs[r.Host]; handler != nil {
31 | handler.ServeHTTP(w, r)
32 | } else {
33 | // Handle host names for wich no handler is registered
34 | http.Error(w, "Forbidden", 403) // Or Redirect?
35 | }
36 | }
37 |
38 | func index(w http.ResponseWriter, _ *http.Request) {
39 | if _, err := fmt.Fprint(w, "Welcome!\n"); err != nil {
40 | panic(err)
41 | }
42 | }
43 |
44 | func hello(w http.ResponseWriter, r *http.Request) {
45 | params, _ := context.Parameters(r.Context())
46 | if _, err := fmt.Fprintf(w, "hello, %s!\n", params.Value("name")); err != nil {
47 | panic(err)
48 | }
49 | }
50 |
51 | func main() {
52 | // Initialize a router as usual
53 | router := gorouter.New()
54 | router.GET("/", http.HandlerFunc(Index))
55 | router.GET("/hello/{name}", http.HandlerFunc(Hello))
56 |
57 | // Make a new HostSwitch and insert the router (our http handler)
58 | // for example.com and port 12345
59 | hs := make(HostSwitch)
60 | hs["example.com:12345"] = router
61 |
62 | // Use the HostSwitch to listen and serve on port 12345
63 | log.Fatal(http.ListenAndServe(":12345", hs))
64 | }
65 | ```
66 |
67 | ```go
68 | package main
69 |
70 | import (
71 | "fmt"
72 | "log"
73 |
74 | "github.com/valyala/fasthttp"
75 | "github.com/vardius/gorouter/v4"
76 | "github.com/vardius/gorouter/v4/context"
77 | )
78 |
79 | // HostSwitch is the host-handler map
80 | // We need an object that implements the fasthttp.RequestHandler interface.
81 | // We just use a map here, in which we map host names (with port) to fasthttp.RequestHandlers
82 | type HostSwitch map[string]fasthttp.RequestHandler
83 |
84 | // CheckHost Implement a CheckHost method on our new type
85 | func (hs HostSwitch) CheckHost(ctx *fasthttp.RequestCtx) {
86 | // Check if a http.Handler is registered for the given host.
87 | // If yes, use it to handle the request.
88 | if handler := hs[string(ctx.Host())]; handler != nil {
89 | handler(ctx)
90 | } else {
91 | // Handle host names for wich no handler is registered
92 | ctx.Error("Forbidden", 403) // Or Redirect?
93 | }
94 | }
95 |
96 | func index(_ *fasthttp.RequestCtx) {
97 | fmt.Print("Welcome!\n")
98 | }
99 |
100 | func hello(ctx *fasthttp.RequestCtx) {
101 | params := ctx.UserValue("params").(context.Params)
102 | fmt.Printf("Hello, %s!\n", params.Value("name"))
103 | }
104 |
105 | func main() {
106 | router := gorouter.NewFastHTTPRouter()
107 | router.GET("/", index)
108 | router.GET("/hello/{name}", hello)
109 |
110 | // Make a new HostSwitch and insert the router (our http handler)
111 | // for example.com and port 12345
112 | hs := make(HostSwitch)
113 | hs["example.com:12345"] = router.HandleFastHTTP
114 |
115 | // Use the HostSwitch to listen and serve on port 12345
116 | log.Fatal(fasthttp.ListenAndServe(":12345", hs.CheckHost))
117 | }
118 | ```
119 |
120 |
--------------------------------------------------------------------------------
/middleware/collection_test.go:
--------------------------------------------------------------------------------
1 | package middleware
2 |
3 | import (
4 | "net/http"
5 | "net/http/httptest"
6 | "testing"
7 | )
8 |
9 | func mockMiddleware(body string) Middleware {
10 | fn := func(h Handler) Handler {
11 | return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
12 | if _, err := w.Write([]byte(body)); err != nil {
13 | panic(err)
14 | }
15 | h.(http.Handler).ServeHTTP(w, r)
16 | })
17 | }
18 |
19 | return WrapperFunc(fn)
20 | }
21 |
22 | func TestCollection(t *testing.T) {
23 | middlewareFactory := func(body string, priority uint) Middleware {
24 | fn := func(h Handler) Handler {
25 | return func() string { return body + h.(func() string)() }
26 | }
27 |
28 | return WithPriority(WrapperFunc(fn), priority)
29 | }
30 | type test struct {
31 | name string
32 | m Collection
33 | output string
34 | sortedOutput string
35 | }
36 | tests := []test{
37 | {"Empty", NewCollection(), "h", "h"},
38 | {"Single middleware", NewCollection(middlewareFactory("0", 0)), "0h", "0h"},
39 | {"Multiple unsorted middleware", NewCollection(middlewareFactory("3", 3), middlewareFactory("1", 1), middlewareFactory("2", 2)), "312h", "123h"},
40 | {"Multiple unsorted middleware 2", NewCollection(middlewareFactory("2", 2), middlewareFactory("1", 1), middlewareFactory("3", 3)), "213h", "123h"},
41 | {"Multiple unsorted middleware 3", NewCollection(middlewareFactory("1", 1), middlewareFactory("3", 3), middlewareFactory("2", 2)), "132h", "123h"},
42 | {"Multiple sorted middleware", NewCollection(middlewareFactory("1", 1), middlewareFactory("2", 2), middlewareFactory("3", 3)), "123h", "123h"},
43 | }
44 | for _, tt := range tests {
45 | t.Run(tt.name, func(t *testing.T) {
46 | m := NewCollection(tt.m...)
47 | h := m.Compose(func() string { return "h" })
48 |
49 | result := h.(func() string)()
50 |
51 | if h.(func() string)() != tt.output {
52 | t.Errorf("NewCollection: h() = %v, want %v", result, tt.output)
53 | }
54 |
55 | h = m.Sort().Compose(func() string { return "h" })
56 |
57 | result = h.(func() string)()
58 |
59 | if h.(func() string)() != tt.sortedOutput {
60 | t.Errorf("NewCollection: h() = %v, want %v", result, tt.sortedOutput)
61 | }
62 | })
63 | }
64 | }
65 |
66 | func TestWithPriority(t *testing.T) {
67 | m1 := WithPriority(mockMiddleware("1"), 3)
68 | m2 := WithPriority(mockMiddleware("2"), 2)
69 | m3 := WithPriority(mockMiddleware("3"), 1)
70 | fn := http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
71 | if _, err := w.Write([]byte("4")); err != nil {
72 | t.Fatal(err)
73 | }
74 | })
75 |
76 | m := NewCollection(m1, m2, m3)
77 | h := m.Sort().Compose(fn).(http.Handler)
78 |
79 | w := httptest.NewRecorder()
80 | r, err := http.NewRequest("GET", "/", nil)
81 | if err != nil {
82 | t.Fatal(err)
83 | }
84 |
85 | h.ServeHTTP(w, r)
86 |
87 | if w.Body.String() != "3214" {
88 | t.Error("The order is incorrect")
89 | }
90 | }
91 |
92 | func TestMerge(t *testing.T) {
93 | m1 := mockMiddleware("1")
94 | m2 := mockMiddleware("2")
95 | m3 := mockMiddleware("3")
96 | fn := http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
97 | if _, err := w.Write([]byte("4")); err != nil {
98 | t.Fatal(err)
99 | }
100 | })
101 |
102 | m := NewCollection(m1)
103 | m = m.Merge(NewCollection(m2, m3))
104 | h := m.Compose(fn).(http.Handler)
105 |
106 | w := httptest.NewRecorder()
107 | r, err := http.NewRequest("GET", "/", nil)
108 | if err != nil {
109 | t.Fatal(err)
110 | }
111 |
112 | h.ServeHTTP(w, r)
113 |
114 | if w.Body.String() != "1234" {
115 | t.Errorf("The order is incorrect expected: 1234 actual: %s", w.Body.String())
116 | }
117 | }
118 |
119 | func TestCompose(t *testing.T) {
120 | m := NewCollection(mockMiddleware("1"))
121 | h := m.Compose(nil)
122 |
123 | if h != nil {
124 | t.Fail()
125 | }
126 | }
127 |
--------------------------------------------------------------------------------
/website/src/siteConfig.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright (c) 2017-present, Facebook, Inc.
3 | *
4 | * This source code is licensed under the MIT license found in the
5 | * LICENSE file in the root directory of this source tree.
6 | */
7 |
8 | // See https://docusaurus.io/docs/site-config for all the possible
9 | // site configuration options.
10 |
11 | // List of projects/orgs using your project for the users page.
12 | const users = [
13 | // {
14 | // caption: "go-api-boilerplate",
15 | // // You will need to prepend the image path with your baseUrl
16 | // // if it is not '/', like: '/test-site/img/image.jpg'.
17 | // image: "/img/undraw_open_source.svg",
18 | // infoLink: "https://github.com/vardius/go-api-boilerplate",
19 | // pinned: true
20 | // }
21 | ];
22 |
23 | const siteConfig = {
24 | title: "gorouter", // Title for your website.
25 | tagline:
26 | "Go Server/API micro framework, HTTP request router, multiplexer, mux",
27 | url: "https://rafallorenz.com/", // Your website URL
28 | baseUrl: "/gorouter/", // Base URL for your project */
29 | // For github.io type URLs, you would set the url and baseUrl like:
30 | // url: 'https://facebook.github.io',
31 | // baseUrl: '/test-site/',
32 |
33 | // Used for publishing and more
34 | projectName: "gorouter",
35 | organizationName: "vardius",
36 | // For top-level user or org sites, the organization is still the same.
37 | // e.g., for the https://JoelMarcey.github.io site, it would be set like...
38 | // organizationName: 'JoelMarcey'
39 |
40 | // For no header links in the top nav bar -> headerLinks: [],
41 | headerLinks: [
42 | { doc: "installation", label: "Docs" },
43 | { page: "help", label: "Help" },
44 | // { page: "users", label: "Users" },
45 | { href: "https://github.com/vardius/gorouter", label: "GitHub" }
46 | // { blog: true, label: 'Blog'},
47 | // { languages: true },
48 | // { search: true }
49 | ],
50 |
51 | docsSideNavCollapsible: true,
52 |
53 | // If you have users set above, you add it here:
54 | users,
55 |
56 | /* path to images for header/footer */
57 | headerIcon: "img/apple-touch-icon.png",
58 | footerIcon: "img/apple-touch-icon.png",
59 | favicon: "favicon/favicon.ico",
60 |
61 | /* Colors for website */
62 | colors: {
63 | primaryColor: "#3e4f4e",
64 | secondaryColor: "#6e8d7c"
65 | },
66 |
67 | /* Custom fonts for website */
68 | /*
69 | fonts: {
70 | myFont: [
71 | "Times New Roman",
72 | "Serif"
73 | ],
74 | myOtherFont: [
75 | "-apple-system",
76 | "system-ui"
77 | ]
78 | },
79 | */
80 |
81 | // This copyright info is used in /core/Footer.js and blog RSS/Atom feeds.
82 | copyright: `Copyright © ${new Date().getFullYear()} Rafał Lorenz`,
83 |
84 | highlight: {
85 | // Highlight.js theme to use for syntax highlighting in code blocks.
86 | theme: "darcula"
87 | },
88 |
89 | // Add custom scripts here that would be placed in