ginS
import "github.com/gin-gonic/gin/ginS"
Functions
func Any(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
Any is a wrapper for Engine.Any.
func DELETE(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
DELETE is a shortcut for router.Handle("DELETE", path, handle)
func GET(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
GET is a shortcut for router.Handle("GET", path, handle)
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(httpMethod, relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
Handle is a wrapper for Engine.Handle.
func LoadHTMLFS(fs http.FileSystem, patterns ...string)
LoadHTMLFS is a wrapper for Engine.LoadHTMLFS.
func LoadHTMLFiles(files ...string)
LoadHTMLFiles is a wrapper for Engine.LoadHTMLFiles.
func LoadHTMLGlob(pattern string)
LoadHTMLGlob is a wrapper for Engine.LoadHTMLGlob.
func NoMethod(handlers ...gin.HandlerFunc)
NoMethod is a wrapper for Engine.NoMethod.
func NoRoute(handlers ...gin.HandlerFunc)
NoRoute adds handlers for NoRoute. It returns a 404 code by default.
func OPTIONS(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
OPTIONS is a shortcut for router.Handle("OPTIONS", path, handle)
func PATCH(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
PATCH is a shortcut for router.Handle("PATCH", path, handle)
func POST(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
POST is a shortcut for router.Handle("POST", path, handle)
func PUT(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
PUT is a shortcut for router.Handle("PUT", path, handle)
func QUERY(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes
QUERY is a shortcut for router.Handle("QUERY", path, handle)
func Routes() gin.RoutesInfo
Routes returns a slice of registered routes.
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(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 an error happens.
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(file string) (err error)
RunUnix attaches to a http.Server and starts listening and serving HTTP requests through the specified unix socket (i.e. a file) Note: this method will block the calling goroutine indefinitely unless an error happens.
func SetHTMLTemplate(templ *template.Template)
SetHTMLTemplate is a wrapper for Engine.SetHTMLTemplate.
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(relativePath string, fs http.FileSystem) gin.IRoutes
StaticFS is a wrapper for Engine.StaticFS.
func StaticFile(relativePath, filepath string) gin.IRoutes
StaticFile is a wrapper for Engine.StaticFile.
func Use(middlewares ...gin.HandlerFunc) gin.IRoutes
Use attaches a global middleware to the router. i.e. the middlewares attached through 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.