README
¶
Fiber is a router framework build on top of FastHTTP, the fastest HTTP package for Go.
This library is inspired by Express, one of the most populair and well known web framework for Nodejs.
Full API Documentation
Installing
Assuming you’ve already installed Go, install the Fiber package by calling the following command:
$ go get -u github.com/fenny/fiber
Hello world
Embedded below is essentially the simplest Fiber app you can create.
$ create server.go
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)
}
$ go run server.go
Browse to http://localhost:8080 and you should see Hello, World! on the page.
Basic routing
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 handler function, that is executed when the route is matched.
Route definition takes the following structures:
// Function signature
app.Method(path string, static string)
app.Method(path string, func(*fiber.Ctx))
app.Method(static string)
app.Method(func(*fiber.Ctx))
- app is an instance of Fiber.
- Method is an HTTP request method, in capitalization: Get, Put, Post etc
- path string is a path or prefix (for static files) on the server.
- static string is a file path or directory.
- *func(fiber.Ctx) is a function executed when the route is matched.
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 example.
The following examples illustrate defining simple routes.
// Respond with Hello, World! on the homepage:
app.Get("/", func(c *fiber.Ctx) {
c.Send("Hello, World!")
})
//Respond to POST request on the root route (/), the application’s home page:
app.Post("/", func(c *fiber.Ctx) {
c.Send("Got a POST request")
})
// Respond to a PUT request to the /user route:
app.Put("/user", func(c *fiber.Ctx) {
c.Send("Got a PUT request at /user")
})
// Respond to a DELETE request to the /user route:
app.Delete("/user", func(c *fiber.Ctx) {
c.Send("Got a DELETE request at /user")
})
Static files
To serve static files such as images, CSS files, and JavaScript files, replace your function handler with a file or directory string.
// Function signature
app.Method(static string)
app.Method(path string, static string)
For example, use the following code to serve images, CSS files, and JavaScript files in a directory named public:
app.Get("./public")
Now, you can load the files that are in the public directory:
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
To use multiple static assets directories, call the express.static middleware function multiple times:
app.Get("./public")
app.Get("./files")
?>For best results, use a reverse proxy cache like NGINX to improve performance of serving static assets.
To create a virtual path prefix (where the path does not actually exist in the file system) for files that are served by the express.static function, specify a mount path for the static directory, as shown below:
app.Get("/static", "./public")
Now, you can load the files that are in the public directory from the /static path prefix.
http://localhost:8080/static/images/kitten.jpg
http://localhost:8080/static/css/style.css
http://localhost:8080/static/js/app.js
http://localhost:8080/static/images/bg.png
http://localhost:8080/static/hello.html
Caught a mistake? Edit this page on GitHub!
Documentation
¶
Index ¶
- Constants
- type Ctx
- func (ctx *Ctx) Attachment(args ...interface{})
- func (ctx *Ctx) BasicAuth() (user, pass string, ok bool)
- func (ctx *Ctx) Body(args ...interface{}) string
- func (ctx *Ctx) ClearCookies(args ...interface{})
- func (ctx *Ctx) Cookies(args ...interface{}) string
- func (ctx *Ctx) Download(args ...interface{})
- func (ctx *Ctx) FormFile(key string) (*multipart.FileHeader, error)
- func (ctx *Ctx) FormValue(key string) string
- func (ctx *Ctx) Get(key string) string
- func (ctx *Ctx) Hostname() string
- func (ctx *Ctx) IP() string
- func (ctx *Ctx) Is(ext string) bool
- func (ctx *Ctx) Json(v interface{}) error
- func (ctx *Ctx) Location(path string)
- func (ctx *Ctx) Method() string
- func (ctx *Ctx) MultipartForm() (*multipart.Form, error)
- func (ctx *Ctx) Next()
- func (ctx *Ctx) OriginalURL() string
- func (ctx *Ctx) Params(key string) string
- func (ctx *Ctx) Path() string
- func (ctx *Ctx) Protocol() string
- func (ctx *Ctx) Query(key string) string
- func (ctx *Ctx) Redirect(args ...interface{})
- func (ctx *Ctx) SaveFile(fh *multipart.FileHeader, path string)
- func (ctx *Ctx) Secure() bool
- func (ctx *Ctx) Send(args ...interface{})
- func (ctx *Ctx) SendFile(file string)
- func (ctx *Ctx) Set(key string, val string)
- func (ctx *Ctx) Status(status int) *Ctx
- func (ctx *Ctx) Type(ext string) *Ctx
- func (ctx *Ctx) Write(args ...interface{})
- func (ctx *Ctx) Xhr() bool
- type Fiber
- func (r *Fiber) All(args ...interface{})
- func (r *Fiber) Connect(args ...interface{})
- func (r *Fiber) Delete(args ...interface{})
- func (r *Fiber) Get(args ...interface{})
- func (r *Fiber) Head(args ...interface{})
- func (r *Fiber) Listen(args ...interface{})
- func (r *Fiber) Options(args ...interface{})
- func (r *Fiber) Patch(args ...interface{})
- func (r *Fiber) Post(args ...interface{})
- func (r *Fiber) Put(args ...interface{})
- func (r *Fiber) Trace(args ...interface{})
- func (r *Fiber) Use(args ...interface{})
- type Settings
Constants ¶
const (
Version = `v0.4.0`
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Ctx ¶
type Ctx struct {
Fasthttp *fasthttp.RequestCtx
// contains filtered or unexported fields
}
Context struct
func (*Ctx) FormFile ¶
func (ctx *Ctx) FormFile(key string) (*multipart.FileHeader, error)
FormFile :
func (*Ctx) MultipartForm ¶
MultipartForm :
type Fiber ¶
type Fiber struct {
Settings *Settings
// contains filtered or unexported fields
}
Fiber :
type Settings ¶
type Settings struct {
Name string
ClearTerminal bool
HideBanner bool
TLSEnable bool
CertKey string
CertFile string
Concurrency int
DisableKeepAlive bool
ReadBufferSize int
WriteBufferSize int
ReadTimeout time.Duration
WriteTimeout time.Duration
IdleTimeout time.Duration
MaxConnsPerIP int
MaxRequestsPerConn int
TCPKeepalive bool
TCPKeepalivePeriod time.Duration
MaxRequestBodySize int
ReduceMemoryUsage bool
GetOnly bool
DisableHeaderNamesNormalizing bool
SleepWhenConcurrencyLimitsExceeded time.Duration
NoDefaultServerHeader bool
NoDefaultContentType bool
KeepHijackedConns bool
}
Settings :
Source Files