static/README.md

88 lines
1.8 KiB
Markdown
Raw Normal View History

# static middleware
[![Build Status](https://travis-ci.org/gin-contrib/static.svg)](https://travis-ci.org/gin-contrib/static)
[![codecov](https://codecov.io/gh/gin-contrib/static/branch/master/graph/badge.svg)](https://codecov.io/gh/gin-contrib/static)
[![Go Report Card](https://goreportcard.com/badge/github.com/gin-contrib/static)](https://goreportcard.com/report/github.com/gin-contrib/static)
[![GoDoc](https://godoc.org/github.com/gin-contrib/static?status.svg)](https://godoc.org/github.com/gin-contrib/static)
2016-12-13 04:40:49 +03:00
Static middleware
## Usage
### Start using it
Download and install it:
```sh
2021-04-04 01:07:43 +03:00
go get github.com/gin-contrib/static
```
Import it in your code:
```go
import "github.com/gin-contrib/static"
```
2021-04-04 01:07:43 +03:00
### Canonical example
See the [example](example)
#### Serve local file
2021-04-04 01:07:43 +03:00
```go
package main
import (
2021-04-04 01:07:43 +03:00
"github.com/gin-contrib/static"
"github.com/gin-gonic/gin"
)
func main() {
2021-04-04 01:07:43 +03:00
r := gin.Default()
// if Allow DirectoryIndex
//r.Use(static.Serve("/", static.LocalFile("/tmp", true)))
// set prefix
//r.Use(static.Serve("/static", static.LocalFile("/tmp", true)))
r.Use(static.Serve("/", static.LocalFile("/tmp", false)))
r.GET("/ping", func(c *gin.Context) {
c.String(200, "test")
})
// Listen and Server in 0.0.0.0:8080
r.Run(":8080")
}
```
#### Serve embed folder
2021-04-04 01:07:43 +03:00
```go
package main
import (
2021-04-04 01:07:43 +03:00
"embed"
"fmt"
"net/http"
2021-04-04 01:07:43 +03:00
"github.com/gin-contrib/static"
"github.com/gin-gonic/gin"
)
//go:embed data
var server embed.FS
func main() {
2021-04-04 01:07:43 +03:00
r := gin.Default()
r.Use(static.Serve("/", static.EmbedFolder(server, "data/server")))
r.GET("/ping", func(c *gin.Context) {
c.String(200, "test")
})
r.NoRoute(func(c *gin.Context) {
fmt.Printf("%s doesn't exists, redirect on /\n", c.Request.URL.Path)
c.Redirect(http.StatusMovedPermanently, "/")
})
// Listen and Server in 0.0.0.0:8080
r.Run(":8080")
}
```