static

README

Package Static

This package help to manage static file router in an API to embedded files into the go binary api. This package requires packr tools, golib/router & go Gin Tonic API Framework.

Example of implementation

We will work on an example of file/folder tree like this :

/
  bin/
    api/
      config/
      routers/
        static/
          get.go
  static/
    static/
      ...some_static_files...

in the get.go file, we will implement the static package call :

package static

import (
    "github.com/gin-gonic/gin"
	"github.com/gobuffalo/packr"
	"github.com/nabbar/golib/static"

    "myapp/release"
    "myapp/bin/api/config"
    "myapp/bin/api/routers"
)

const UrlPrefix = "/static"

func init() {
	staticStcFile := static.NewStatic(false, UrlPrefix, packr.NewBox("../../../../static/static"), GetHeader)

	staticStcFile.SetDownloadAll()
	staticStcFile.Register(routers.RouterList.Register)
}

func GetHeader(c *gin.Context) {
    // any function to return global & generic header (like CSP, HSTS, ...)
}

Documentation

Index

• Constants
• func IsCodeError() bool
• type Static
  • func NewStatic(hasIndex bool, prefix string, box packr.Box, Header gin.HandlerFunc) Static

Constants

const (
	EMPTY_PARAMS errors.CodeError = iota + errors.MIN_PKG_Static
	EMPTY_PACKED
	INDEX_NOT_FOUND
	INDEX_REQUESTED_NOT_SET
	FILE_NOT_FOUND
)

const (
	FileIndex = "index.html"
)

Functions

func IsCodeError

func IsCodeError() bool

Types

type Static

type Static interface {
	Register(register router.RegisterRouter)
	RegisterInGroup(group string, register router.RegisterRouterInGroup)

	SetDownloadAll()
	SetDownload(file string)
	IsDownload(file string) bool

	Has(file string) bool
	Find(file string) ([]byte, error)

	Health() Error
	Get(c *gin.Context)
}

func NewStatic

func NewStatic(hasIndex bool, prefix string, box packr.Box, Header gin.HandlerFunc) Static