mirror of https://github.com/gofiber/fiber.git
114 lines
3.5 KiB
Markdown
114 lines
3.5 KiB
Markdown
<p align="center">
|
||
<img height="150" src="https://gofiber.github.io/fiber/static/logo.jpg">
|
||
</p>
|
||
<!--
|
||
|
||
|
||
-->
|
||
|
||
# Fiber     
|
||
|
||
**[Fiber](https://github.com/gofiber/fiber)** is an **[Express](https://expressjs.com/en/4x/api.html)** styled HTTP framework implementation running on **[Fasthttp](https://github.com/valyala/fasthttp)**, the **fastest** HTTP engine for **[Go](https://golang.org/doc/)**. The package make use of similar framework convention as they are in express. People switching from **[Node](https://nodejs.org/en/about/)** to **[Go](https://golang.org/doc/)** often end up in a bad learning curve to start building their webapps, this project is meant to **ease** things up for **fast** development, but with **zero memory allocation** and **performance** in mind. See **[API Documentation](https://gofiber.github.io/fiber/)**
|
||
|
||
[](https://gofiber.github.io/fiber/#/benchmarks)
|
||
|
||
## Features
|
||
* Optimized for speed and low memory usage.
|
||
* Rapid Server-Side Programming
|
||
* Easy routing with parameters
|
||
* Static files with custom prefix
|
||
* Middleware with Next support
|
||
* Express API endpoints
|
||
* **[API Documentation](https://gofiber.github.io/fiber/)**
|
||
|
||
## Installing
|
||
Assuming you’ve already installed **[Go](https://golang.org/doc/)**, install the **[Fiber](https://github.com/gofiber/fiber)** package by calling the following command:
|
||
```bash
|
||
$ go get -u github.com/gofiber/fiber
|
||
```
|
||
|
||
## Hello world
|
||
Embedded below is essentially the simplest Fiber app you can create.
|
||
```bash
|
||
$ create server.go
|
||
```
|
||
```go
|
||
package main
|
||
|
||
import "github.com/gofiber/fiber"
|
||
|
||
func main() {
|
||
app := fiber.New()
|
||
|
||
app.Get("/", func(c *fiber.Ctx) {
|
||
c.Send("Hello, World!")
|
||
})
|
||
|
||
app.Listen(8080)
|
||
}
|
||
```
|
||
```bash
|
||
$ go run server.go
|
||
```
|
||
Browse to **http://localhost:8080** and you should see `Hello, World!` on the page.
|
||
|
||
## Static files
|
||
To serve static files, use the [Static](https://gofiber.github.io/fiber/#/?id=static-files) method.
|
||
```go
|
||
package main
|
||
|
||
import "github.com/gofiber/fiber"
|
||
|
||
func main() {
|
||
app := fiber.New()
|
||
|
||
app.Static("./public")
|
||
|
||
app.Listen(8080)
|
||
}
|
||
```
|
||
Now, you can load the files that are in the public directory:
|
||
```shell
|
||
http://localhost:8080/hello.html
|
||
http://localhost:8080/js/jquery.js
|
||
http://localhost:8080/css/style.css
|
||
```
|
||
|
||
## Middleware
|
||
Middleware has never been so easy, just like express you call the Next() matching route function!
|
||
```go
|
||
package main
|
||
|
||
import "github.com/gofiber/fiber"
|
||
|
||
func main() {
|
||
app := fiber.New()
|
||
|
||
app.Get("/", func(c *fiber.Ctx) {
|
||
c.Set("random-header", "random-value")
|
||
c.Write("1st route!\n")
|
||
c.Next()
|
||
})
|
||
app.Get("/", func(c *fiber.Ctx) {
|
||
c.Write("2nd route!\n")
|
||
c.Next()
|
||
})
|
||
app.Get("/", func(c *fiber.Ctx) {
|
||
c.Write("3rd route!\n")
|
||
})
|
||
|
||
|
||
app.Listen(8080)
|
||
}
|
||
```
|
||
|
||
## API Documentation
|
||
We created an extended API documentation including examples, **[click here](https://gofiber.github.io/fiber/)**
|
||
|
||
## License
|
||
gofiber/fiber is free and open-source software licensed under the [MIT License](https://github.com/gofiber/fiber/edit/master/LICENSE).
|
||
|
||
|
||
|
||
*Caught a mistake? [Edit this page on GitHub!](https://github.com/gofiber/fiber/blob/master/README.md)*
|