mirror of https://github.com/gofiber/fiber.git
Add files via upload
Fenny
GitHub
parent
cc61b56955
commit
d95b5b033d
220
docs/README.md
220
docs/README.md
|
|
@ -2,21 +2,21 @@
|
|||
docsify init ./docs
|
||||
docsify serve ./docs
|
||||
-->
|
||||
|
||||
[](http://godoc.org/github.com/fenny/fiber) [](https://fuzzit.dev) [](https://goreportcard.com/report/github.com/fenny/fiber) [](https://gitter.im/fiber-chat/community)<br>
|
||||
<img src="logo.jpg" width="150" alt="accessibility text"><br>
|
||||
<img src="logo.jpg" width="150" alt="accessibility text"><br><br>
|
||||
[](http://godoc.org/github.com/fenny/fiber) [](https://fuzzit.dev) [](https://goreportcard.com/report/github.com/fenny/fiber) [](https://gitter.im/fiber-chat/community)<br><br>
|
||||
**Fiber** is a router framework build on top of [FastHTTP](https://github.com/valyala/fasthttp), the fastest HTTP package for **Go**.<br>
|
||||
This library is inspired by [Expressjs](https://github.com/expressjs/fiber), one of the most populair and well known web framework for **Nodejs**.
|
||||
|
||||
### Getting started
|
||||
|
||||
#### Installing
|
||||
|
||||
Assuming you’ve already installed Golang, install the Fiber package by calling the following command:
|
||||
```shell
|
||||
$ go get -u github.com/fenny/fiber
|
||||
```
|
||||
|
||||
#### Hello world
|
||||
Embedded below is essentially the simplest Fiber app you can create.
|
||||
```shell
|
||||
$ create server.go
|
||||
```
|
||||
|
|
@ -25,12 +25,12 @@ package main
|
|||
|
||||
import "github.com/fenny/fiber"
|
||||
|
||||
func main {
|
||||
app := fiber.New()
|
||||
app.Get("/", func(c *fiber.Ctx) {
|
||||
c.Send("Hello, World!")
|
||||
})
|
||||
app.Listen(8080)
|
||||
func main() {
|
||||
app := fiber.New()
|
||||
app.Get("/", func(c *fiber.Ctx) {
|
||||
c.Send("Hello, World!")
|
||||
})
|
||||
app.Listen(8080)
|
||||
}
|
||||
```
|
||||
```shell
|
||||
|
|
@ -42,7 +42,7 @@ Browse to http://localhost:8080 and you should see Hello, World! on the page.
|
|||
|
||||
Routing refers to determining how an application responds to a client request to a particular endpoint, which is a URI (or path) and a specific HTTP request method (GET, POST, and so on).
|
||||
|
||||
Each route can have one or more handler functions, which are executed when the route is matched.
|
||||
Each route can have one handler function, that is executed when the route is matched.
|
||||
|
||||
Route definition takes the following structures:
|
||||
|
||||
|
|
@ -59,60 +59,151 @@ app.Method(path, handler)
|
|||
This tutorial assumes that an instance of fiber named app is created and the server is running. If you are not familiar with creating an app and starting it, see the [Hello world](#hello-world) example.
|
||||
|
||||
The following examples illustrate defining simple routes.
|
||||
Respond with Hello World! on the homepage:
|
||||
Respond with Hello, World! on the homepage:
|
||||
```go
|
||||
app.Get("/", func(c *fiber.Context) {
|
||||
app.Get("/", func(c *fiber.Ctx) {
|
||||
c.Send("Hello, World!")
|
||||
})
|
||||
```
|
||||
|
||||
Respond to POST request on the root route (/), the application’s home page:
|
||||
```go
|
||||
app.Post("/", func(c *fiber.Context) {
|
||||
app.Post("/", func(c *fiber.Ctx) {
|
||||
c.Send("Got a POST request")
|
||||
})
|
||||
```
|
||||
|
||||
Respond to a PUT request to the /user route:
|
||||
```go
|
||||
app.Put("/user", func(c *fiber.Context) {
|
||||
app.Put("/user", func(c *fiber.Ctx) {
|
||||
c.Send("Got a PUT request at /user")
|
||||
})
|
||||
```
|
||||
|
||||
Respond to a DELETE request to the /user route:
|
||||
```go
|
||||
app.Delete("/user", func(c *fiber.Context) {
|
||||
app.Delete("/user", func(c *fiber.Ctx) {
|
||||
c.Send("Got a DELETE request at /user")
|
||||
})
|
||||
```
|
||||
|
||||
#### Static files
|
||||
Input a folder or file
|
||||
To serve static files such as images, CSS files, and JavaScript files, use the express.static built-in middleware function in Express.
|
||||
|
||||
The function signature is:
|
||||
```go
|
||||
app.Get("/", fiber.Static("./static"))
|
||||
app.Get("/css", fiber.Static("./public/compiled/css"))
|
||||
|
||||
// Or if you work with pushstates
|
||||
app.Get("*", fiber.Static("./static/index.html"))
|
||||
fiber.Static(root string)
|
||||
```
|
||||
The root argument specifies the root directory from which to serve static assets.
|
||||
You can also specify a single file instead of a directory, for example:
|
||||
|
||||
```go
|
||||
app.Get("/", fiber.Static("./public"))
|
||||
app.Get("/", fiber.Static("./public/index.html"))
|
||||
```
|
||||
Now, you can load the files that are in the public directory:
|
||||
```bash
|
||||
http://localhost:8080/images/kitten.jpg
|
||||
http://localhost:8080/css/style.css
|
||||
http://localhost:8080/js/app.js
|
||||
http://localhost:8080/images/bg.png
|
||||
http://localhost:8080/hello.html
|
||||
http://localhost:8080 # => serves "index.html"
|
||||
```
|
||||
|
||||
Fiber looks up the files relative to the static directory, so the name of the static directory is not part of the URL.
|
||||
To create a virtual path prefix (where the path does not actually exist in the file system) for files that are served by the fiber.Static function, specify a mount path for the static directory, as shown below:
|
||||
```go
|
||||
app.Get("/css", fiber.Static("./build/css/minified"))
|
||||
```
|
||||
|
||||
|
||||
### Application
|
||||
|
||||
The app object conventionally denotes the Fiber application.
|
||||
#### Initialize
|
||||
Creates an Fiber instance.
|
||||
```go
|
||||
app := fiber.New()
|
||||
```
|
||||
#### Settings
|
||||
#### Methods
|
||||
#### Listen
|
||||
You can pass any of the Fasthttp server settings via the Fiber instance.
|
||||
Make sure that you set these settings before calling the .Listen() method.
|
||||
|
||||
The following values are default.
|
||||
I suggest you only play with these settings if you know what you are doing.
|
||||
```go
|
||||
app := fiber.New()
|
||||
|
||||
app.TLSEnable = false,
|
||||
app.CertKey = ""
|
||||
app.CertFile = ""
|
||||
app.Name = ""
|
||||
app.Concurrency = 256 * 1024
|
||||
app.DisableKeepAlive = false
|
||||
app.ReadBufferSize = 4096
|
||||
app.WriteBufferSize = 4096
|
||||
app.WriteTimeout = 0
|
||||
app.IdleTimeout = 0
|
||||
app.MaxConnsPerIP = 0
|
||||
app.MaxRequestsPerConn = 0
|
||||
app.TCPKeepalive = false
|
||||
app.TCPKeepalivePeriod = 0
|
||||
app.MaxRequestBodySize = 4 * 1024 * 1024
|
||||
app.ReduceMemoryUsage = false
|
||||
app.GetOnly = false
|
||||
app.DisableHeaderNamesNormalizing = false
|
||||
app.SleepWhenConcurrencyLimitsExceeded = 0
|
||||
app.NoDefaultServerHeader = true
|
||||
app.NoDefaultContentType = false
|
||||
KeepHijackedConns = false
|
||||
```
|
||||
#### Methods
|
||||
Routes an HTTP request, where METHOD is the HTTP method of the request, such as GET, PUT, POST, and so on, in lowercase. Thus, the actual methods are app.get(), app.post(), app.put(), and so on. See Routing methods below for the complete list.
|
||||
```go
|
||||
app.Get("/", func(c *fiber.Ctx) {})
|
||||
app.Put("/", func(c *fiber.Ctx) {})
|
||||
app.Post("/", func(c *fiber.Ctx) {})
|
||||
app.Delete("/", func(c *fiber.Ctx) {})
|
||||
app.Head("/", func(c *fiber.Ctx) {})
|
||||
app.Patch("/", func(c *fiber.Ctx) {})
|
||||
app.Options("/", func(c *fiber.Ctx) {})
|
||||
app.Trace("/", func(c *fiber.Ctx) {})
|
||||
app.Connect("/", func(c *fiber.Ctx) {})
|
||||
// Matches all HTTP verbs
|
||||
app.All("/", func(c *fiber.Ctx) {})
|
||||
```
|
||||
#### Listen
|
||||
Binds and listens for connections on the specified host and port.
|
||||
```go
|
||||
app.Listen(8080)
|
||||
app.Listen("127.0.0.1", 8080)
|
||||
```
|
||||
### Routing
|
||||
|
||||
### Context
|
||||
#### Paths
|
||||
Route paths, in combination with a request method, define the endpoints at which requests can be made. Route paths can be strings, string patterns, or regular expressions.
|
||||
|
||||
The characters ?, +, "8", and () are subsets of their regular expression counterparts. The hyphen (-) and the dot (.) are interpreted literally by string-based paths.
|
||||
|
||||
If you need to use the dollar character ($) in a path string, enclose it escaped within ([ and ]). For example, the path string for requests at “/data/$book”, would be “/data/([\$])book”.
|
||||
|
||||
#### Parameters
|
||||
Route parameters are named URL segments that are used to capture the values specified at their position in the URL. The captured values are populated in the req.params object, with the name of the route parameter specified in the path as their respective keys.
|
||||
|
||||
#### Middleware
|
||||
You can provide multiple callback functions that behave like middleware to handle a request. The only exception is that these callbacks might invoke next('route') to bypass the remaining route callbacks. You can use this mechanism to impose pre-conditions on a route, then pass control to subsequent routes if there’s no reason to proceed with the current route.
|
||||
|
||||
Route handlers can be in the form of a function, an array of functions, or combinations of both, as shown in the following examples.
|
||||
|
||||
A single callback function can handle a route. For example:
|
||||
### Context
|
||||
The ctx object represents the HTTP request and response and has methods for the request query string, parameters, body, HTTP headers, and so on. In this documentation and by convention, the context is always referred to as c but its actual name is determined by the parameters to the callback function in which you’re working.
|
||||
#### Accepts
|
||||
|
||||
#### Attachment
|
||||
Sets the HTTP response Content-Disposition header field to “attachment”. If a filename is given, then it sets the Content-Type based on the extension name via res.type(), and sets the Content-Disposition “filename=” parameter.
|
||||
```go
|
||||
app.Get("/", func(c *fiber.Context) {
|
||||
app.Get("/", func(c *fiber.Ctx) {
|
||||
c.Attachment()
|
||||
// Content-Disposition: attachment
|
||||
c.Attachment("./static/img/logo.png")
|
||||
|
|
@ -120,13 +211,23 @@ app.Get("/", func(c *fiber.Context) {
|
|||
// Content-Type: image/png
|
||||
})
|
||||
```
|
||||
#### BaseUrl
|
||||
|
||||
#### Body
|
||||
Contains key-value pairs of data submitted in the request body. By default, it is undefined, and is populated when you use body-parsing middleware such as express.json() or express.urlencoded().
|
||||
|
||||
#### ClearCookies
|
||||
The following example shows how to use body-parsing middleware to populate req.body.
|
||||
```go
|
||||
app.Get("/", func(c *fiber.Context) {
|
||||
app.Post("/", func(c *fiber.Ctx) {
|
||||
c.Body()
|
||||
c.Body("param1")
|
||||
c.Body(func(key string, val string) {
|
||||
fmt.Printl(key, val)
|
||||
})
|
||||
})
|
||||
```
|
||||
#### ClearCookies
|
||||
Clears all cookies, or a specific cookie by name.
|
||||
```go
|
||||
app.Get("/", func(c *fiber.Ctx) {
|
||||
// Delete all cookies from client side
|
||||
c.ClearCookies()
|
||||
|
||||
|
|
@ -136,8 +237,12 @@ app.Get("/", func(c *fiber.Context) {
|
|||
```
|
||||
|
||||
#### Cookies
|
||||
Clears all cookies, or a specific cookie by name.
|
||||
```go
|
||||
app.Get("/", func(c *fiber.Context) {
|
||||
app.Get("/", func(c *fiber.Ctx) {
|
||||
// Returns Cookie header value
|
||||
c.Cookies()
|
||||
|
||||
// Create cookie name=john
|
||||
c.Cookies("name", "john")
|
||||
|
||||
|
|
@ -154,26 +259,53 @@ app.Get("/", func(c *fiber.Context) {
|
|||
#### Get
|
||||
Returns the HTTP response header specified by field. The match is case-insensitive.
|
||||
```go
|
||||
app.Get("/", func(c *fiber.Context) {
|
||||
app.Get("/", func(c *fiber.Ctx) {
|
||||
c.Get("Content-Type")
|
||||
// "text/plain"
|
||||
|
||||
c.Get("content-type")
|
||||
// "text/plain"
|
||||
|
||||
c.Get("something")
|
||||
// ""
|
||||
})
|
||||
```
|
||||
#### Hostname
|
||||
#### Ip
|
||||
Contains the remote IP address of the request.
|
||||
|
||||
When the trust proxy setting does not evaluate to false, the value of this property is derived from the left-most entry in the X-Forwarded-For header. This header can be set by the client or by the proxy.
|
||||
Contains the hostname derived from the Host HTTP header.
|
||||
```go
|
||||
app.Get("/", func(c *fiber.Context) {
|
||||
c.Send(c.Ip())
|
||||
app.Get("/", func(c *fiber.Ctx) {
|
||||
// Host: "localhost:8080"
|
||||
c.Hostname()
|
||||
// => "localhost"
|
||||
})
|
||||
```
|
||||
#### IP
|
||||
Contains the remote IP address of the request.
|
||||
```go
|
||||
app.Get("/", func(c *fiber.Ctx) {
|
||||
c.IP()
|
||||
// "127.0.0.1"
|
||||
})
|
||||
```
|
||||
#### Is
|
||||
Returns the matching content type if the incoming request’s “Content-Type” HTTP header field matches the MIME type specified by the type parameter. If the request has no body, returns null. Returns false otherwise.
|
||||
```go
|
||||
app.Get("/", func(c *fiber.Ctx) {
|
||||
// Content-Type: text/html; charset=utf-8
|
||||
c.Is("html") // => true
|
||||
c.Is(".html") // => true
|
||||
c.Is("json") // => false
|
||||
})
|
||||
```
|
||||
#### Json
|
||||
#### Jsonp
|
||||
#### Method
|
||||
Contains a string corresponding to the HTTP method of the request: GET, POST, PUT, and so on.
|
||||
```go
|
||||
app.Post("/", func(c *fiber.Ctx) {
|
||||
c.Method() // => "POST"
|
||||
})
|
||||
```
|
||||
#### OriginalUrl
|
||||
#### Params
|
||||
#### Path
|
||||
|
|
@ -181,7 +313,7 @@ app.Get("/", func(c *fiber.Context) {
|
|||
#### Query
|
||||
This property is an object containing a property for each query string parameter in the route. If there is no query string, it returns an empty string
|
||||
```go
|
||||
app.Get("/", func(c *fiber.Context) {
|
||||
app.Get("/", func(c *fiber.Ctx) {
|
||||
// GET /search?q=tobi+ferret
|
||||
c.Query("q")
|
||||
// => "tobi ferret"
|
||||
|
|
@ -194,7 +326,7 @@ app.Get("/", func(c *fiber.Context) {
|
|||
#### Redirect
|
||||
Redirects to the URL derived from the specified path, with specified status, a positive integer that corresponds to an HTTP status code . If not specified, status defaults to “302 “Found”.
|
||||
```go
|
||||
app.Get("/", func(c *fiber.Context) {
|
||||
app.Get("/", func(c *fiber.Ctx) {
|
||||
c.Redirect("/foo/bar")
|
||||
c.Redirect("http://example.com")
|
||||
c.Redirect(301, "http://example.com")
|
||||
|
|
@ -209,14 +341,14 @@ app.Get("/", func(c *fiber.Context) {
|
|||
#### Set
|
||||
Sets the response’s HTTP header field to value. To set multiple fields at once, pass an object as the parameter.
|
||||
```go
|
||||
app.Get("/", func(c *fiber.Context) {
|
||||
app.Get("/", func(c *fiber.Ctx) {
|
||||
c.Set("Content-Type", "text/plain")
|
||||
})
|
||||
```
|
||||
#### Status
|
||||
Sets the HTTP status for the response. It is a chainable alias of Node’s response.statusCode.
|
||||
```go
|
||||
app.Get("/", func(c *fiber.Context) {
|
||||
app.Get("/", func(c *fiber.Ctx) {
|
||||
c.Status(403)
|
||||
c.Status(400).Send("Bad Request")
|
||||
c.Status(404).SendFile("/absolute/path/to/404.png")
|
||||
|
|
@ -225,7 +357,7 @@ app.Get("/", func(c *fiber.Context) {
|
|||
#### Type
|
||||
Sets the Content-Type HTTP header to the MIME type as determined by mime.lookup() for the specified type. If type contains the “/” character, then it sets the Content-Type to type.
|
||||
```go
|
||||
app.Get("/", func(c *fiber.Context) {
|
||||
app.Get("/", func(c *fiber.Ctx) {
|
||||
c.Type(".html")
|
||||
// => 'text/html'
|
||||
c.Type("html")
|
||||
|
|
|
|||
116
docs/index.html
116
docs/index.html
|
|
@ -7,25 +7,84 @@
|
|||
<meta name="description" content="Description">
|
||||
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
|
||||
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
|
||||
<link href="https://fonts.googleapis.com/css?family=Fira+Mono&display=swap" rel="stylesheet">
|
||||
<style>
|
||||
:focus {outline:none;}
|
||||
::-moz-focus-inner {border:0;}
|
||||
.app-name-link > img {
|
||||
width: 115px;
|
||||
}
|
||||
.sidebar-nav > ul > li > a {
|
||||
font-weight: 700;
|
||||
}
|
||||
.sidebar-nav > ul > ul > li {
|
||||
margin: 0px 0;
|
||||
line-height: 1.5em;
|
||||
}
|
||||
.sidebar-nav > ul > ul {
|
||||
display: none;
|
||||
}
|
||||
.sidebar-nav > ul > ul.active {
|
||||
display: block;
|
||||
}
|
||||
|
||||
|
||||
:focus {
|
||||
outline: none;
|
||||
}
|
||||
|
||||
::-moz-focus-inner {
|
||||
border: 0;
|
||||
}
|
||||
|
||||
.app-name-link>img {
|
||||
width: 115px;
|
||||
}
|
||||
|
||||
.sidebar-nav>ul>li>a {
|
||||
font-weight: 700;
|
||||
}
|
||||
|
||||
.sidebar-nav>ul>ul>li {
|
||||
margin: 0px 0;
|
||||
line-height: 1.5em;
|
||||
}
|
||||
|
||||
.sidebar-nav>ul>ul {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.sidebar-nav>ul>ul.active {
|
||||
display: block;
|
||||
}
|
||||
|
||||
pre>code {
|
||||
font-family: 'Fira Mono' !important;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.token.function {
|
||||
color: hsl(207, 82%, 66%);
|
||||
}
|
||||
|
||||
.token.keyword {
|
||||
color: hsl(286, 60%, 67%);
|
||||
}
|
||||
|
||||
.token.string {
|
||||
color: hsl( 95, 38%, 62%);
|
||||
}
|
||||
|
||||
.token.boolean,
|
||||
.token.number {
|
||||
color: hsl( 29, 54%, 61%);
|
||||
}
|
||||
|
||||
code .token {
|
||||
color: hsl(286, 60%, 67%);
|
||||
}
|
||||
|
||||
.markdown-section pre>code,
|
||||
.markdown-section code,
|
||||
.markdown-section pre {
|
||||
background-color: #313440;
|
||||
}
|
||||
|
||||
.markdown-section pre>code,
|
||||
.token.punctuation {
|
||||
color: hsl(220, 14%, 71%);
|
||||
}
|
||||
|
||||
.token.cdata,
|
||||
.token.comment,
|
||||
.token.doctype,
|
||||
.token.prolog {
|
||||
color: hsl(220, 10%, 40%);
|
||||
}
|
||||
.token.property { color: hsl(187, 47%, 55%); }
|
||||
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
|
|
@ -38,7 +97,24 @@
|
|||
</script>
|
||||
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js"></script>
|
||||
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
|
||||
<script src="//unpkg.com/prismjs/components/prism-go.min.js"></script>
|
||||
<script type="text/javascript" src="https://unpkg.com/prismjs@1.17.1/components/prism-bash.js">
|
||||
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
Prism.languages.go = Prism.languages.extend('clike', {
|
||||
'keyword': /\b(?:break|case|chan|const|continue|default|defer|else|fallthrough|for|func|go(?:to)?|if|import|interface|map|package|range|return|select|struct|switch|type|var)\b/,
|
||||
'builtin': /\b(?:bool|byte|complex(?:64|128)|error|float(?:32|64)|rune|string|u?int(?:8|16|32|64)?|uintptr|append|cap|close|complex|copy|delete|imag|len|make|new|panic|print(?:ln)?|real|recover)\b/,
|
||||
'boolean': /\b(?:_|iota|nil|true|false)\b/,
|
||||
'operator': /[*\/%^!=]=?|\+[=+]?|-[=-]?|\|[=|]?|&(?:=|&|\^=?)?|>(?:>=?|=)?|<(?:<=?|=|-)?|:=|\.\.\./,
|
||||
'number': /(?:\b0x[a-f\d]+|(?:\b\d+\.?\d*|\B\.\d+)(?:e[-+]?\d+)?)i?/i,
|
||||
'function': /\w+(?=\()/,
|
||||
'string': {
|
||||
pattern: /(["'`])(\\[\s\S]|(?!\1)[^\\])*\1/,
|
||||
greedy: true
|
||||
},
|
||||
'property': /\b(\w*Ctx\w*)\b/,
|
||||
});
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
window.addEventListener('hashchange', function (e) {
|
||||
var hash = window.location.hash
|
||||
|
|
@ -46,7 +122,7 @@
|
|||
$('.section-link[href="' + hash + '"]').trigger('click')
|
||||
$('.section-link[href="' + hash + '"]').parent().parent().addClass('active')
|
||||
})
|
||||
$(document).ready(function() {
|
||||
$(window).ready(function() {
|
||||
setTimeout(function() {
|
||||
var hash = window.location.hash
|
||||
if (hash == '#/') {
|
||||
|
|
|
|||
Loading…
Reference in New Issue