gin/ginS/gins.go

148 lines
5.1 KiB
Go
Raw Normal View History

2015-08-16 16:44:18 +00:00
// Copyright 2014 Manu Martinez-Almeida. All rights reserved.
// Use of this source code is governed by a MIT style
// license that can be found in the LICENSE file.
package ginS
import (
"html/template"
"net/http"
"sync"
"github.com/gin-gonic/gin"
2015-08-16 16:44:18 +00:00
)
var once sync.Once
var internalEngine *gin.Engine
2015-08-16 16:44:18 +00:00
func engine() *gin.Engine {
2015-08-16 16:44:18 +00:00
once.Do(func() {
internalEngine = gin.Default()
2015-08-16 16:44:18 +00:00
})
return internalEngine
}
// LoadHTMLGlob is a wrapper for Engine.LoadHTMLGlob.
2015-08-16 16:44:18 +00:00
func LoadHTMLGlob(pattern string) {
engine().LoadHTMLGlob(pattern)
}
// LoadHTMLFiles is a wrapper for Engine.LoadHTMLFiles.
2015-08-16 16:44:18 +00:00
func LoadHTMLFiles(files ...string) {
engine().LoadHTMLFiles(files...)
}
// SetHTMLTemplate is a wrapper for Engine.SetHTMLTemplate.
2015-08-16 16:44:18 +00:00
func SetHTMLTemplate(templ *template.Template) {
engine().SetHTMLTemplate(templ)
}
2016-04-14 23:16:46 +00:00
// NoRoute adds handlers for NoRoute. It return a 404 code by default.
2017-08-27 09:11:38 +00:00
func NoRoute(handlers ...gin.HandlerFunc) {
2015-08-16 16:44:18 +00:00
engine().NoRoute(handlers...)
}
// NoMethod is a wrapper for Engine.NoMethod.
2017-08-27 09:11:38 +00:00
func NoMethod(handlers ...gin.HandlerFunc) {
2015-08-16 16:44:18 +00:00
engine().NoMethod(handlers...)
}
2016-04-14 23:16:46 +00:00
// Group creates a new router group. You should add all the routes that have common middlwares or the same path prefix.
2015-08-16 16:44:18 +00:00
// For example, all the routes that use a common middlware for authorization could be grouped.
2017-08-27 09:11:38 +00:00
func Group(relativePath string, handlers ...gin.HandlerFunc) *gin.RouterGroup {
2015-08-16 16:44:18 +00:00
return engine().Group(relativePath, handlers...)
}
// Handle is a wrapper for Engine.Handle.
2017-08-27 09:11:38 +00:00
func Handle(httpMethod, relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes {
2015-08-16 16:44:18 +00:00
return engine().Handle(httpMethod, relativePath, handlers...)
}
// POST is a shortcut for router.Handle("POST", path, handle)
2017-08-27 09:11:38 +00:00
func POST(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes {
2015-08-16 16:44:18 +00:00
return engine().POST(relativePath, handlers...)
}
// GET is a shortcut for router.Handle("GET", path, handle)
2017-08-27 09:11:38 +00:00
func GET(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes {
2015-08-16 16:44:18 +00:00
return engine().GET(relativePath, handlers...)
}
// DELETE is a shortcut for router.Handle("DELETE", path, handle)
2017-08-27 09:11:38 +00:00
func DELETE(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes {
2015-08-16 16:44:18 +00:00
return engine().DELETE(relativePath, handlers...)
}
// PATCH is a shortcut for router.Handle("PATCH", path, handle)
2017-08-27 09:11:38 +00:00
func PATCH(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes {
2015-08-16 16:44:18 +00:00
return engine().PATCH(relativePath, handlers...)
}
// PUT is a shortcut for router.Handle("PUT", path, handle)
2017-08-27 09:11:38 +00:00
func PUT(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes {
2015-08-16 16:44:18 +00:00
return engine().PUT(relativePath, handlers...)
}
// OPTIONS is a shortcut for router.Handle("OPTIONS", path, handle)
2017-08-27 09:11:38 +00:00
func OPTIONS(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes {
2015-08-16 16:44:18 +00:00
return engine().OPTIONS(relativePath, handlers...)
}
// HEAD is a shortcut for router.Handle("HEAD", path, handle)
2017-08-27 09:11:38 +00:00
func HEAD(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes {
2015-08-16 16:44:18 +00:00
return engine().HEAD(relativePath, handlers...)
}
// Any is a wrapper for Engine.Any.
2017-08-27 09:11:38 +00:00
func Any(relativePath string, handlers ...gin.HandlerFunc) gin.IRoutes {
2015-08-16 16:44:18 +00:00
return engine().Any(relativePath, handlers...)
}
// StaticFile is a wrapper for Engine.StaticFile.
2017-08-27 09:11:38 +00:00
func StaticFile(relativePath, filepath string) gin.IRoutes {
2015-08-16 16:44:18 +00:00
return engine().StaticFile(relativePath, filepath)
}
// 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")
2017-08-27 09:11:38 +00:00
func Static(relativePath, root string) gin.IRoutes {
2015-08-16 16:44:18 +00:00
return engine().Static(relativePath, root)
}
// StaticFS is a wrapper for Engine.StaticFS.
2017-08-27 09:11:38 +00:00
func StaticFS(relativePath string, fs http.FileSystem) gin.IRoutes {
2015-08-16 16:44:18 +00:00
return engine().StaticFS(relativePath, fs)
}
2016-04-14 23:16:46 +00:00
// Use attachs a global middleware to the router. ie. the middlewares attached though Use() will be
2015-08-16 16:44:18 +00:00
// 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.
2017-08-27 09:11:38 +00:00
func Use(middlewares ...gin.HandlerFunc) gin.IRoutes {
2015-08-16 16:44:18 +00:00
return engine().Use(middlewares...)
}
2016-04-14 23:16:46 +00:00
// Run : The router is attached to a http.Server and starts listening and serving HTTP requests.
2015-08-16 16:44:18 +00:00
// It is a shortcut for http.ListenAndServe(addr, router)
// Note: this method will block the calling goroutine undefinitelly unless an error happens.
func Run(addr ...string) (err error) {
return engine().Run(addr...)
}
2016-04-14 23:16:46 +00:00
// RunTLS : The router is attached to a http.Server and starts listening and serving HTTPS requests.
2015-08-16 16:44:18 +00:00
// 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 RunTLS(addr, certFile, keyFile string) (err error) {
2015-08-16 16:44:18 +00:00
return engine().RunTLS(addr, certFile, keyFile)
}
2016-04-14 23:16:46 +00:00
// RunUnix : The router is attached to a http.Server and starts listening and serving HTTP requests
2015-08-16 16:44:18 +00:00
// through the specified unix socket (ie. a file)
// Note: this method will block the calling goroutine undefinitelly unless an error happens.
func RunUnix(file string) (err error) {
return engine().RunUnix(file)
}