swaggerFiles

README

swaggerFiles

Generate swagger ui embedded files by using:

make

Documentation

Index

• Variables
• func ReadFile(path string) ([]byte, error)
• func WalkDirs(name string, includeDirsInList bool, files ...string) ([]string, error)
• func WriteFile(filename string, data []byte, perm os.FileMode) error
• type HTTPFS
  • func (hfs *HTTPFS) Open(path string) (http.File, error)

Variables

var (
	// CTX is a context for webdav vfs
	CTX = context.Background()

	// FS is a virtual memory file system
	FS = webdav.NewMemFS()

	// Handler is used to server files through a http handler
	Handler *webdav.Handler

	// HTTP is the http file system
	HTTP http.FileSystem = new(HTTPFS)
)

var FileFavicon16x16Png []byte

FileFavicon16x16Png is "/favicon-16x16.png"

var FileFavicon32x32Png []byte

FileFavicon32x32Png is "/favicon-32x32.png"

var FileIndexHTML []byte

FileIndexHTML is "/index.html"

var FileOauth2RedirectHTML []byte

FileOauth2RedirectHTML is "/oauth2-redirect.html"

var FileSwaggerUIBundleJs []byte

FileSwaggerUIBundleJs is "/swagger-ui-bundle.js"

var FileSwaggerUIBundleJsMap []byte

FileSwaggerUIBundleJsMap is "/swagger-ui-bundle.js.map"

var FileSwaggerUICSS []byte

FileSwaggerUICSS is "/swagger-ui.css"

var FileSwaggerUICSSMap []byte

FileSwaggerUICSSMap is "/swagger-ui.css.map"

var FileSwaggerUIJs []byte

FileSwaggerUIJs is "/swagger-ui.js"

var FileSwaggerUIJsMap []byte

FileSwaggerUIJsMap is "/swagger-ui.js.map"

var FileSwaggerUIStandalonePresetJs []byte

FileSwaggerUIStandalonePresetJs is "/swagger-ui-standalone-preset.js"

var FileSwaggerUIStandalonePresetJsMap []byte

FileSwaggerUIStandalonePresetJsMap is "/swagger-ui-standalone-preset.js.map"

Functions

func ReadFile

func ReadFile(path string) ([]byte, error)

ReadFile is adapTed from ioutil

func WalkDirs

func WalkDirs(name string, includeDirsInList bool, files ...string) ([]string, error)

WalkDirs looks for files in the given dir and returns a list of files in it usage for all files in the b0x: WalkDirs("", false)

func WriteFile

func WriteFile(filename string, data []byte, perm os.FileMode) error

WriteFile is adapTed from ioutil

Types

type HTTPFS

type HTTPFS struct {
	// Prefix allows to limit the path of all requests. F.e. a prefix "css" would allow only calls to /css/*
	Prefix string
}

HTTPFS implements http.FileSystem

func (*HTTPFS) Open

func (hfs *HTTPFS) Open(path string) (http.File, error)

Open a file