Static middleware
Go to file
Bo-Yi Wu 722aa5b1b5
ci: refine GitHub Actions and Release Workflow
- Update the GolangCI-Lint action to version 5 in the GitHub workflow for Go
- Change the Goreleaser argument from `--rm-dist` to `--clean` in the GitHub workflow
- Remove the `project_name` setting from the `.goreleaser.yaml` file
- Simplify the `skip` setting for builds in `.goreleaser.yaml`
- Change the changelog configuration to use the GitHub API instead of git logs in `.goreleaser.yaml`
- Update the titles for changelog groups from single to double quotes in `.goreleaser.yaml`
- Add new changelog groups for refactoring, build process updates, and documentation updates in `.goreleaser.yaml`
- Remove the filters section that excluded commits from the changelog based on certain patterns in `.goreleaser.yaml`

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2024-05-05 09:06:01 +08:00
.github ci: refine GitHub Actions and Release Workflow 2024-05-05 09:06:01 +08:00
_example chore: refactor example directory structure 2024-02-17 16:37:16 +08:00
test/data/server feat: Implement embed folder and a better organisation 2021-03-15 19:11:55 +01:00
.gitignore remove vendor files. (#5) 2017-03-15 06:49:17 -05:00
.golangci.yml chore: refactor Lint Configuration for Go Project 2024-02-17 16:19:53 +08:00
.goreleaser.yaml ci: refine GitHub Actions and Release Workflow 2024-05-05 09:06:01 +08:00
LICENSE Initial commit 2016-12-13 09:40:49 +08:00
README.md feat: enhance static file serving capabilities 2024-02-17 16:24:16 +08:00
embed_folder.go feat: Implement embed folder and a better organisation 2021-03-15 19:11:55 +01:00
embed_folder_test.go feat: Implement embed folder and a better organisation 2021-03-15 19:11:55 +01:00
go.mod chore: update dependencies across multiple modules 2024-05-05 09:05:02 +08:00
go.sum chore: update dependencies across multiple modules 2024-05-05 09:05:02 +08:00
local_file.go feat: Implement embed folder and a better organisation 2021-03-15 19:11:55 +01:00
local_file_test.go test: improve reliability of file operations 2024-02-17 16:26:13 +08:00
serve.go feat: Implement embed folder and a better organisation 2021-03-15 19:11:55 +01:00
serve_test.go style: refactor tests and update CI configurations 2024-02-17 16:39:35 +08:00

README.md

static middleware

Run Tests codecov Go Report Card GoDoc

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)
  }
}