GitBook: [master] 4 pages modified

Author: Fenny

README.md

@@ -33,7 +33,7 @@ func main() {
   app.Get("/", func(c *fiber.Ctx) {
     c.Send("Hello, World!")
   })
-  
+
   app.Listen(3000)
 }
 ```
@@ -65,7 +65,7 @@ app.Method(path string, ...func(*fiber.Ctx))
 * `path` is a path on the server.
 * `func(*fiber.Ctx)` is a callback function containing the [Context](https://fiber.wiki/context) executed when the route is matched.
 
-### Simple route
+**Simple route**
 
 ```go
 // Respond with "Hello, World!" on root path, "/":
@@ -74,7 +74,7 @@ app.Get("/", func(c *fiber.Ctx) {
 })
 ```
 
-### Route with parameter
+**Route with parameter**
 
 ```go
 // GET http://localhost:8080/hello%20world
@@ -85,7 +85,7 @@ app.Get("/:value", func(c *fiber.Ctx) {
 })
 ```
 
-### Route with optional parameter
+**Route with optional parameter**
 
 ```go
 // GET http://localhost:8080/hello%20world
@@ -101,7 +101,7 @@ app.Get("/:value?", func(c *fiber.Ctx) {
 })
 ```
 
-### Route with wildcard
+**Route with wildcard**
 
 ```go
 // GET http://localhost:8080/api/user/john

application.md

@@ -43,16 +43,16 @@ func main() {
         Prefork:       true,
         CaseSensitive: true,
         StrictRouting: true,
-        ServerHeader:  "Go",
-        // etc...
+        ServerHeader:  "Fiber",
+        // ...
     })
 
     // Or change Settings after initiating app
     app.Settings.Prefork = true
     app.Settings.CaseSensitive = true
     app.Settings.StrictRouting = true
-    app.Settings.ServerHeader = true
-    // etc...
+    app.Settings.ServerHeader = "Fiber"
+    // ...
 
     app.Listen(3000)
 }
@@ -168,7 +168,7 @@ func main() {
       <td style="text-align:left"><code>string</code>
       </td>
       <td style="text-align:left">If you preset the template file extension, you do not need to provide
-        the full filename in the Render function: <code>c.Render(&quot;home&quot;, d) -&gt; home.pug</code>
+        the full filename in the Render function: <code>c.Render(&quot;home&quot;, data) -&gt; home.pug</code>
       </td>
       <td style="text-align:left"><code>&quot;html&quot;</code>
       </td>
@@ -185,7 +185,6 @@ By default, this method will send `index.html` files in response to a request on
 **Signature**
 
 ```go
-app.Static(root string)         // => without prefix
 app.Static(prefix, root string) // => with prefix
 ```
 
@@ -194,7 +193,7 @@ app.Static(prefix, root string) // => with prefix
 Use the following code to serve files in a directory named `./public`
 
 ```go
-app.Static("./public")
+app.Static("/", "./public")
 
 // => http://localhost:3000/hello.html
 // => http://localhost:3000/js/jquery.js
@@ -205,17 +204,17 @@ To serve from multiple directories, you can use **Static** multiple times.
 
 ```go
 // Serve files from "./public" directory:
-app.Static("./public")
+app.Static("/", "./public")
 
 // Serve files from "./files" directory:
-app.Static("./files")
+app.Static("/", "./files")
 ```
 
 {% hint style="info" %}
 Use a reverse proxy cache like [NGINX](https://www.nginx.com/resources/wiki/start/topics/examples/reverseproxycachingexample/) to improve performance of serving static assets.
 {% endhint %}
 
-To create a virtual path prefix \(_where the path does not actually exist in the file system_\) for files that are served by the **Static** method, specify a prefix path for the static directory, as shown below:
+You can use any virtual path prefix \(_where the path does not actually exist in the file system_\) for files that are served by the **Static** method, specify a prefix path for the static directory, as shown below:
 
 ```go
 app.Static("/static", "./public")
@@ -232,8 +231,8 @@ Routes an HTTP request, where **METHOD** is the [HTTP method](https://developer.
 **Signature**
 
 ```go
-/* These methods support :param & :optional? in path
-   You are required to pass a path to each method    */
+// HTTP methods support :param, :optional? and *wildcards
+// You are required to pass a path to each method
 app.All(path string, handlers ...func(*Ctx))
 app.Get(...
 app.Put(...
@@ -245,9 +244,9 @@ app.Delete(...
 app.Connect(...
 app.Options(...
 
-/* Use will only match the prefix of each path
-   i.e. "/john" will match "/john/doe", "/johnnnn"
-   Use does not support :param & :optional? in path   */
+// Use() will only match the beggining of each path
+// i.e. "/john" will match "/john/doe", "/johnnnn"
+// Use() does not support :param & :optional? in path
 app.Use(handlers ...func(*Ctx))
 app.Use(prefix string, handlers ...func(*Ctx))
 ```
@@ -295,7 +294,7 @@ func main() {
     app := fiber.New()
     // Optional middleware
     app.Use("/ws", func(c *fiber.Ctx) {
-        if c.Get("host") == "localhost:3000" {
+        if c.Get("host") != "localhost:3000" {
             c.Status(403).Send("Request origin not allowed")
         } else {
             c.Next()
@@ -352,47 +351,14 @@ func main() {
 }
 ```
 
-## Recover
-
-You can recover from panic errors in any handler by registering a `Recover` method. You can access the panic error by calling [`Error()`](https://github.com/gofiber/docs/tree/2f0839895190c02779e91237531b27445d4427c6/context/README.md#error)
-
-{% hint style="info" %}
-Recover is disabled by default unless you register a handler.
-{% endhint %}
-
-**Signature**
-
-```go
-app.Recover(handler func(*Ctx))
-```
-
-**Example**
-
-```go
-func main() {
-  app := fiber.New()
-
-  app.Get("/", func(c *fiber.Ctx) {
-    panic("Something went wrong!")
-  })
-
-  app.Recover(func(c *fiber.Ctx) {
-    c.Status(500).Send(c.Error())
-    // => 500 "Something went wrong!"
-  })
-
-  app.Listen(3000)
-}
-```
-
 ## Listen
 
 Binds and listens for connections on the specified address. This can be a `int` for port or `string` for address.
 
 **Signature**
 
 ```go
-app.Listen(address interface{}, tls ...string)
+app.Listen(address interface{}, tls ...*tls.Config)
 ```
 
 **Example**
@@ -404,10 +370,16 @@ app.Listen(":8080")
 app.Listen("127.0.0.1:8080")
 ```
 
-To enable **TLS/HTTPS** you can append your **cert** and **key** path.
+To enable **TLS/HTTPS** you can append a ****[**TLS config**](https://golang.org/pkg/crypto/tls/#Config).
 
 ```go
-app.Listen(443, "server.crt", "server.key")
+cer, err := tls.LoadX509KeyPair("server.crt", "server.key")
+if err != nil {
+    log.Fatal(err)
+}
+config := &tls.Config{Certificates: []tls.Certificate{cer}}
+
+app.Listen(443, config)
 ```
 
 ## Test

context.md

@@ -49,10 +49,10 @@ Fiber provides similar functions for the other accept headers.
 app.Get("/", func(c *fiber.Ctx) {
   c.AcceptsCharsets("utf-16", "iso-8859-1") 
   // "iso-8859-1"
-  
+
   c.AcceptsEncodings("compress", "br") 
   // "compress"
-  
+
   c.AcceptsLanguages("pt", "nl", "ru") 
   // "nl" "ru"
 })
@@ -276,8 +276,8 @@ func main() {
   })
 }
 ```
-```
 
+```text
 ## Cookie
 
 Set cookies
@@ -290,13 +290,13 @@ c.Cookie(*Cookie)
 
 ```go
 type Cookie struct {
-	Name     string
-	Value    string
-	Path     string
-	Domain   string
-	Expires  time.Time
-	Secure   bool
-	HTTPOnly bool
+    Name     string
+    Value    string
+    Path     string
+    Domain   string
+    Expires  time.Time
+    Secure   bool
+    HTTPOnly bool
 }
 ```
 
@@ -306,11 +306,11 @@ type Cookie struct {
 app.Get("/", func(c *fiber.Ctx) {
   // Create cookie
   cookie := new(fiber.Cookie)
-	cookie.Name = "john"
-	cookie.Value = "doe"
-	cookie.Expires = time.Now().Add(24 * time.Hour)
-	// Set cookie
-	c.Cookie(cookie)
+    cookie.Name = "john"
+    cookie.Value = "doe"
+    cookie.Expires = time.Now().Add(24 * time.Hour)
+    // Set cookie
+    c.Cookie(cookie)
 })
 ```
 
@@ -509,7 +509,7 @@ Not implemented yet, pull requests are welcome!
 
 ## Get
 
-Returns the HTTP request header specified by field. 
+Returns the HTTP request header specified by field.
 
 {% hint style="success" %}
 The match is **case-insensitive**.
@@ -1000,11 +1000,11 @@ c.Range(int size)
 
 ```go
 type Range struct {
-	Type   string
-	Ranges []struct {
-		Start int64
-		End   int64
-	}
+    Type   string
+    Ranges []struct {
+        Start int64
+        End   int64
+    }
 }
 ```
 
@@ -1015,7 +1015,7 @@ type Range struct {
 app.Get("/", func(c *fiber.Ctx) {
   b := c.Range(1000)
   if b.Type == "bytes" {
-  	for r := range r.Ranges {
+      for r := range r.Ranges {
       fmt.Println(r)
       // [500, 700]
     }
@@ -1066,7 +1066,7 @@ Renders a template with data and sends a `text/html` response. We support the fo
 c.Render(file string, data interface{}, engine ...string) error
 ```
 
-A simple template file with the ****`mustache` ****syntax.
+A simple template file with the **`mustache`** syntax.
 
 {% code title="/views/home.tmpl" %}
 ```go
@@ -1406,7 +1406,7 @@ c.Vary(field ...string)
 app.Get("/", func(c *fiber.Ctx) {
   c.Vary("Origin")     // => Vary: Origin
   c.Vary("User-Agent") // => Vary: Origin, User-Agent
-  
+
   // No duplicates
   c.Vary("Origin") // => Vary: Origin, User-Agent
 

middleware.md

@@ -204,6 +204,42 @@ func main() {
 }
 ```
 
+## Recover
+
+You can recover from panic errors within any route. By default the Recover middleware will respond with `500 Internal Server Error` when a panic occurs. You can also provide your own error handler.
+
+**Signature**
+
+```go
+middleware.Recover(handle ...func(*Ctx, error)) func(*Ctx)
+```
+
+**Example**
+
+```go
+package main
+
+import (
+    "github.com/gofiber/fiber"
+    "github.com/gofiber/fiber/middleware"
+)
+
+func main() {
+  app := fiber.New()
+
+  app.Use(middleware.Recover(func(c *fiber.Ctx, err error) {
+    log.Println(err)  // "Something went wrong!"
+    c.SendStatus(500) // Internal Server Error
+  })))
+  
+  app.Get("/", func(c *fiber.Ctx) {
+    panic("Something went wrong!")
+  })
+
+  app.Listen(3000)
+}
+```
+
 ## RequestID
 
 RequestID adds an indentifier to the request using the `X-Request-ID` header