vendor/github.com/gorilla/mux/README.md

   1 mux
   2 ===
   3 [![GoDoc](https://godoc.org/github.com/gorilla/mux?status.svg)](https://godoc.org/github.com/gorilla/mux)
   4 [![Build Status](https://travis-ci.org/gorilla/mux.svg?branch=master)](https://travis-ci.org/gorilla/mux)
   5
   6 http://www.gorillatoolkit.org/pkg/mux
   7
   8 Package `gorilla/mux` implements a request router and dispatcher.
   9
  10 The name mux stands for "HTTP request multiplexer". Like the standard `http.ServeMux`, `mux.Router` matches incoming requests against a list of registered routes and calls a handler for the route that matches the URL or other conditions. The main features are:
  11
  12 * Requests can be matched based on URL host, path, path prefix, schemes, header and query values, HTTP methods or using custom matchers.
  13 * URL hosts and paths can have variables with an optional regular expression.
  14 * Registered URLs can be built, or "reversed", which helps maintaining references to resources.
  15 * Routes can be used as subrouters: nested routes are only tested if the parent route matches. This is useful to define groups of routes that share common conditions like a host, a path prefix or other repeated attributes. As a bonus, this optimizes request matching.
  16 * It implements the `http.Handler` interface so it is compatible with the standard `http.ServeMux`.
  17
  18 Let's start registering a couple of URL paths and handlers:
  19
  20 ```go
  21 func main() {
  22         r := mux.NewRouter()
  23         r.HandleFunc("/", HomeHandler)
  24         r.HandleFunc("/products", ProductsHandler)
  25         r.HandleFunc("/articles", ArticlesHandler)
  26         http.Handle("/", r)
  27 }
  28 ```
  29
  30 Here we register three routes mapping URL paths to handlers. This is equivalent to how `http.HandleFunc()` works: if an incoming request URL matches one of the paths, the corresponding handler is called passing (`http.ResponseWriter`, `*http.Request`) as parameters.
  31
  32 Paths can have variables. They are defined using the format `{name}` or `{name:pattern}`. If a regular expression pattern is not defined, the matched variable will be anything until the next slash. For example:
  33
  34 ```go
  35 r := mux.NewRouter()
  36 r.HandleFunc("/products/{key}", ProductHandler)
  37 r.HandleFunc("/articles/{category}/", ArticlesCategoryHandler)
  38 r.HandleFunc("/articles/{category}/{id:[0-9]+}", ArticleHandler)
  39 ```
  40
  41 The names are used to create a map of route variables which can be retrieved calling `mux.Vars()`:
  42
  43 ```go
  44 vars := mux.Vars(request)
  45 category := vars["category"]
  46 ```
  47
  48 And this is all you need to know about the basic usage. More advanced options are explained below.
  49
  50 Routes can also be restricted to a domain or subdomain. Just define a host pattern to be matched. They can also have variables:
  51
  52 ```go
  53 r := mux.NewRouter()
  54 // Only matches if domain is "www.example.com".
  55 r.Host("www.example.com")
  56 // Matches a dynamic subdomain.
  57 r.Host("{subdomain:[a-z]+}.domain.com")
  58 ```
  59
  60 There are several other matchers that can be added. To match path prefixes:
  61
  62 ```go
  63 r.PathPrefix("/products/")
  64 ```
  65
  66 ...or HTTP methods:
  67
  68 ```go
  69 r.Methods("GET", "POST")
  70 ```
  71
  72 ...or URL schemes:
  73
  74 ```go
  75 r.Schemes("https")
  76 ```
  77
  78 ...or header values:
  79
  80 ```go
  81 r.Headers("X-Requested-With", "XMLHttpRequest")
  82 ```
  83
  84 ...or query values:
  85
  86 ```go
  87 r.Queries("key", "value")
  88 ```
  89
  90 ...or to use a custom matcher function:
  91
  92 ```go
  93 r.MatcherFunc(func(r *http.Request, rm *RouteMatch) bool {
  94         return r.ProtoMajor == 0
  95 })
  96 ```
  97
  98 ...and finally, it is possible to combine several matchers in a single route:
  99
 100 ```go
 101 r.HandleFunc("/products", ProductsHandler).
 102   Host("www.example.com").
 103   Methods("GET").
 104   Schemes("http")
 105 ```
 106
 107 Setting the same matching conditions again and again can be boring, so we have a way to group several routes that share the same requirements. We call it "subrouting".
 108
 109 For example, let's say we have several URLs that should only match when the host is `www.example.com`. Create a route for that host and get a "subrouter" from it:
 110
 111 ```go
 112 r := mux.NewRouter()
 113 s := r.Host("www.example.com").Subrouter()
 114 ```
 115
 116 Then register routes in the subrouter:
 117
 118 ```go
 119 s.HandleFunc("/products/", ProductsHandler)
 120 s.HandleFunc("/products/{key}", ProductHandler)
 121 s.HandleFunc("/articles/{category}/{id:[0-9]+}"), ArticleHandler)
 122 ```
 123
 124 The three URL paths we registered above will only be tested if the domain is `www.example.com`, because the subrouter is tested first. This is not only convenient, but also optimizes request matching. You can create subrouters combining any attribute matchers accepted by a route.
 125
 126 Subrouters can be used to create domain or path "namespaces": you define subrouters in a central place and then parts of the app can register its paths relatively to a given subrouter.
 127
 128 There's one more thing about subroutes. When a subrouter has a path prefix, the inner routes use it as base for their paths:
 129
 130 ```go
 131 r := mux.NewRouter()
 132 s := r.PathPrefix("/products").Subrouter()
 133 // "/products/"
 134 s.HandleFunc("/", ProductsHandler)
 135 // "/products/{key}/"
 136 s.HandleFunc("/{key}/", ProductHandler)
 137 // "/products/{key}/details"
 138 s.HandleFunc("/{key}/details", ProductDetailsHandler)
 139 ```
 140
 141 Now let's see how to build registered URLs.
 142
 143 Routes can be named. All routes that define a name can have their URLs built, or "reversed". We define a name calling `Name()` on a route. For example:
 144
 145 ```go
 146 r := mux.NewRouter()
 147 r.HandleFunc("/articles/{category}/{id:[0-9]+}", ArticleHandler).
 148   Name("article")
 149 ```
 150
 151 To build a URL, get the route and call the `URL()` method, passing a sequence of key/value pairs for the route variables. For the previous route, we would do:
 152
 153 ```go
 154 url, err := r.Get("article").URL("category", "technology", "id", "42")
 155 ```
 156
 157 ...and the result will be a `url.URL` with the following path:
 158
 159 ```
 160 "/articles/technology/42"
 161 ```
 162
 163 This also works for host variables:
 164
 165 ```go
 166 r := mux.NewRouter()
 167 r.Host("{subdomain}.domain.com").
 168   Path("/articles/{category}/{id:[0-9]+}").
 169   HandlerFunc(ArticleHandler).
 170   Name("article")
 171
 172 // url.String() will be "http://news.domain.com/articles/technology/42"
 173 url, err := r.Get("article").URL("subdomain", "news",
 174                                  "category", "technology",
 175                                  "id", "42")
 176 ```
 177
 178 All variables defined in the route are required, and their values must conform to the corresponding patterns. These requirements guarantee that a generated URL will always match a registered route -- the only exception is for explicitly defined "build-only" routes which never match.
 179
 180 Regex support also exists for matching Headers within a route. For example, we could do:
 181
 182 ```go
 183 r.HeadersRegexp("Content-Type", "application/(text|json)")
 184 ```
 185
 186 ...and the route will match both requests with a Content-Type of `application/json` as well as `application/text`
 187
 188 There's also a way to build only the URL host or path for a route: use the methods `URLHost()` or `URLPath()` instead. For the previous route, we would do:
 189
 190 ```go
 191 // "http://news.domain.com/"
 192 host, err := r.Get("article").URLHost("subdomain", "news")
 193
 194 // "/articles/technology/42"
 195 path, err := r.Get("article").URLPath("category", "technology", "id", "42")
 196 ```
 197
 198 And if you use subrouters, host and path defined separately can be built as well:
 199
 200 ```go
 201 r := mux.NewRouter()
 202 s := r.Host("{subdomain}.domain.com").Subrouter()
 203 s.Path("/articles/{category}/{id:[0-9]+}").
 204   HandlerFunc(ArticleHandler).
 205   Name("article")
 206
 207 // "http://news.domain.com/articles/technology/42"
 208 url, err := r.Get("article").URL("subdomain", "news",
 209                                  "category", "technology",
 210                                  "id", "42")
 211 ```
 212
 213 ## Full Example
 214
 215 Here's a complete, runnable example of a small `mux` based server:
 216
 217 ```go
 218 package main
 219
 220 import (
 221         "net/http"
 222
 223         "github.com/gorilla/mux"
 224 )
 225
 226 func YourHandler(w http.ResponseWriter, r *http.Request) {
 227         w.Write([]byte("Gorilla!\n"))
 228 }
 229
 230 func main() {
 231         r := mux.NewRouter()
 232         // Routes consist of a path and a handler function.
 233         r.HandleFunc("/", YourHandler)
 234
 235         // Bind to a port and pass our router in
 236         http.ListenAndServe(":8000", r)
 237 }
 238 ```
 239
 240 ## License
 241
 242 BSD licensed. See the LICENSE file for details.