acf41a9a1a
- Add documentation for serving local files and embedded folders in README.md - Add new example code for serving embedded folders in Go - Create new `embed_folder.go` file with functions to serve embedded folders - Create new `embed_folder_test.go` file with tests for serving embedded folders - Add HTML template files for embedded server example - Rename `static.go` to `local_file.go` and remove unused code - Create new `local_file_test.go` file with tests for serving local files - Create new `serve.go` file with middleware handler for serving static files - Rename `static_test.go` to `serve_test.go` and refactor test functions - Remove redundant test case `TestListIndex` from `serve_test.go` Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> |
||
---|---|---|
.github | ||
_example | ||
example/embed | ||
test/data/server | ||
.gitignore | ||
.golangci.yml | ||
.goreleaser.yaml | ||
LICENSE | ||
README.md | ||
embed_folder.go | ||
embed_folder_test.go | ||
go.mod | ||
go.sum | ||
local_file.go | ||
local_file_test.go | ||
serve.go | ||
serve_test.go |
README.md
static middleware
Static middleware
Usage
Start using it
Download and install it:
go get github.com/gin-contrib/static
Import it in your code:
import "github.com/gin-contrib/static"
Canonical example
See the example
Serve local file
package main
import (
"github.com/gin-contrib/static"
"github.com/gin-gonic/gin"
)
func main() {
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
package main
import (
"embed"
"fmt"
"net/http"
"github.com/gin-contrib/static"
"github.com/gin-gonic/gin"
)
//go:embed data
var server embed.FS
func main() {
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")
if err := r.Run(":8080"); err != nil {
log.Fatal(err)
}
}