Back to godoc.org

Package ginS

v1.1.5-0...-b8b6831
Latest Go to latest

The latest major version is .

Published: Sep 29, 2017 | License: MIT | Module: github.com/Apptc/gin

Index

func Any

func Any(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

func DELETE

func DELETE(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

DELETE is a shortcut for router.Handle("DELETE", path, handle)

func GET

func GET(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

GET is a shortcut for router.Handle("GET", path, handle)

func Group

func Group(relativePath string, handlers ...gin.HandlerFunc) *gin.RouterGroup

Group creates a new router group. You should add all the routes that have common middlwares or the same path prefix. For example, all the routes that use a common middlware for authorization could be grouped.

func HEAD(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

HEAD is a shortcut for router.Handle("HEAD", path, handle)

func Handle

func Handle(httpMethod, relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

func LoadHTMLFiles

func LoadHTMLFiles(files ...string)

func LoadHTMLGlob

func LoadHTMLGlob(pattern string)

func NoMethod

func NoMethod(handlers ...gin.HandlerFunc)

NoMethod sets the handlers called when... TODO

func NoRoute

func NoRoute(handlers ...gin.HandlerFunc)

NoRoute adds handlers for NoRoute. It return a 404 code by default.

func OPTIONS

func OPTIONS(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

OPTIONS is a shortcut for router.Handle("OPTIONS", path, handle)

func PATCH

func PATCH(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

PATCH is a shortcut for router.Handle("PATCH", path, handle)

func POST

func POST(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

POST is a shortcut for router.Handle("POST", path, handle)

func PUT

func PUT(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes

PUT is a shortcut for router.Handle("PUT", path, handle)

func Run

func Run(addr ...string) (err error)

Run : The router is attached to a http.Server and starts listening and serving HTTP requests. It is a shortcut for http.ListenAndServe(addr, router) Note: this method will block the calling goroutine undefinitelly unless an error happens.

func RunTLS

func RunTLS(addr string, certFile string, keyFile string) (err error)

RunTLS : The router is attached to a http.Server and starts listening and serving HTTPS requests. It is a shortcut for http.ListenAndServeTLS(addr, certFile, keyFile, router) Note: this method will block the calling goroutine undefinitelly unless an error happens.

func RunUnix

func RunUnix(file string) (err error)

RunUnix : The router is attached to a http.Server and starts listening and serving HTTP requests through the specified unix socket (ie. a file) Note: this method will block the calling goroutine undefinitelly unless an error happens.

func SetHTMLTemplate

func SetHTMLTemplate(templ *template.Template)

func Static

func Static(relativePath, root string) gin.IRoutes

Static serves files from the given file system root. Internally a http.FileServer is used, therefore http.NotFound is used instead of the Router's NotFound handler. To use the operating system's file system implementation, use :

router.Static("/static", "/var/www")

func StaticFS

func StaticFS(relativePath string, fs http.FileSystem) gin.IRoutes

func StaticFile

func StaticFile(relativePath, filepath string) gin.IRoutes

func Use

func Use(middlewares ...gin.HandlerFunc) gin.IRoutes

Use attachs a global middleware to the router. ie. the middlewares attached though Use() will be included in the handlers chain for every single request. Even 404, 405, static files... For example, this is the right place for a logger or error management middleware.

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier