gin: github.com/gin-gonic/gin/ginS Index | Files

package ginS

import "github.com/gin-gonic/gin/ginS"

Index

Package Files

gins.go

func Any Uses

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

Any is a wrapper for Engine.Any.

func DELETE Uses

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

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

func GET Uses

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

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

func Group Uses

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

Group creates a new router group. You should add all the routes that have common middlewares or the same path prefix. For example, all the routes that use a common middleware 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 Uses

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

Handle is a wrapper for Engine.Handle.

func LoadHTMLFiles Uses

func LoadHTMLFiles(files ...string)

LoadHTMLFiles is a wrapper for Engine.LoadHTMLFiles.

func LoadHTMLGlob Uses

func LoadHTMLGlob(pattern string)

LoadHTMLGlob is a wrapper for Engine.LoadHTMLGlob.

func NoMethod Uses

func NoMethod(handlers ...gin.HandlerFunc)

NoMethod is a wrapper for Engine.NoMethod.

func NoRoute Uses

func NoRoute(handlers ...gin.HandlerFunc)

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

func OPTIONS Uses

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

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

func PATCH Uses

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

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

func POST Uses

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

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

func PUT Uses

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

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

func Routes Uses

func Routes() gin.RoutesInfo

Routes returns a slice of registered routes.

func Run Uses

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

Run attaches 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 indefinitely unless an error happens.

func RunFd Uses

func RunFd(fd int) (err error)

RunFd attaches the router to a http.Server and starts listening and serving HTTP requests through the specified file descriptor. Note: the method will block the calling goroutine indefinitely unless on error happens.

func RunTLS Uses

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

RunTLS attaches 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 indefinitely unless an error happens.

func RunUnix Uses

func RunUnix(file string) (err error)

RunUnix attaches 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 indefinitely unless an error happens.

func SetHTMLTemplate Uses

func SetHTMLTemplate(templ *template.Template)

SetHTMLTemplate is a wrapper for Engine.SetHTMLTemplate.

func Static Uses

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 Uses

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

StaticFS is a wrapper for Engine.StaticFS.

func StaticFile Uses

func StaticFile(relativePath, filepath string) gin.IRoutes

StaticFile is a wrapper for Engine.StaticFile.

func Use Uses

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

Use attaches 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.

Package ginS imports 4 packages (graph). Updated 2019-04-23. Refresh now. Tools for package owners.