https://github.com/lflxp/gin-tryfile
gin middlewares, just like nginx try-file function
https://github.com/lflxp/gin-tryfile
Last synced: 12 months ago
JSON representation
gin middlewares, just like nginx try-file function
- Host: GitHub
- URL: https://github.com/lflxp/gin-tryfile
- Owner: lflxp
- Created: 2022-01-10T13:44:29.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-10T15:36:57.000Z (over 4 years ago)
- Last Synced: 2025-03-27T14:56:52.307Z (over 1 year ago)
- Language: Go
- Size: 5.86 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gin Middleware TryFile
This project is to solve the problem that the gin framework processes the dynamic routing file in the front-end compilation file and imitates nginx try_file function
本项目是解决gin框架处理前端编译文件中动态路由文件，模仿nginx try_file功能
```
location /images/ {
root /opt/html/;
try_files $uri index.html;
}
```
# Usage
`func RegisterTryFile(router *gin.Engine, hfs http.FileSystem, staticFileDir ...string)`
Parameter analysis
* router *gin.Engine
* hfs http.FileSystem
* http.FS
* http.Dir
* http.FS(embed.FS)
* staticFileDir ...string
* only one word as default,which means gin router and static path
* include two word,first is gin router,second is static path, default try file is index.html
* include three word,first is gin router,second is static path,three is try file name eg: index.html
# Demo
```
package main
import (
"embed"
"net/http"
"github.com/gin-gonic/gin"
tryfile "github.com/lflxp/gin-tryfile"
)
//go:embed dist
var distFile embed.FS
func main() {
r := gin.Default()
// As Default, Gin Router equal StaticPath
tryfile.RegisterTryFile(r, http.FS(distFile), "/dist")
// Custom Gin Router and StaticPath
// tryfile.RegisterTryFile(r, http.FS(distFile), "/static", "/dist")
// Fully custom parameters
// tryfile.RegisterTryFile(r, http.FS(distFile), "/static", "/dist/custom", "index.html")
// As you wish
r.Any("/try/file/*any", tryfile.WrapHandler("/dist", http.FS(distFile)))
r.Run()
}
```
## Verification results
```
➜ gin-tryfile git:(main) ✗ curl http://127.0.0.1:8080/dist/this/is/not/exist
Hello Gin-TryFile
➜ gin-tryfile git:(main) ✗ curl http://127.0.0.1:8080/try/file/this/is/not/exist
Hello Gin-TryFile
```