gout

package module

v0.1.0 Latest Latest Go to latest Published: Mar 9, 2023 License: GPL-3.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/MysticalDevil/gout

Links

Open Source Insights

README ¶

Gout

This is a go web framework, like Gin.

Documentation ¶

Overview ¶

Package gout is a go web framework

Index ¶

type Context
type Engine
- func Default() *Engine
- func New() *Engine
type H
type HandlerFunc
- func Logger() HandlerFunc
- func Recovery() HandlerFunc
type RouterGroup

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Context ¶

type Context struct {
	// origin objects
	Writer http.ResponseWriter
	Req    *http.Request
	// request info
	Path   string
	Method string
	Params map[string]string
	// response info
	StatusCode int
	// contains filtered or unexported fields
}

func (*Context) Data ¶

func (c *Context) Data(code int, data []byte)

func (*Context) Fail ¶

func (c *Context) Fail(code int, err string)

func (*Context) HTML ¶

func (c *Context) HTML(code int, name string, data any)

func (*Context) JSON ¶

func (c *Context) JSON(code int, obj any)

func (*Context) Next ¶

func (c *Context) Next()

func (*Context) Param ¶

func (c *Context) Param(key string) string

func (*Context) PostFrom ¶

func (c *Context) PostFrom(key string) string

func (*Context) Query ¶

func (c *Context) Query(key string) string

func (*Context) SetHeader ¶

func (c *Context) SetHeader(key string, value string)

func (*Context) Status ¶

func (c *Context) Status(code int)

func (*Context) String ¶

func (c *Context) String(code int, format string, values ...any)

type Engine ¶

type Engine struct {
	*RouterGroup
	// contains filtered or unexported fields
}

Engine implement the interface of ServeHTTP

func Default ¶

func Default() *Engine

Default is base on New with Logger middleware

func New ¶

func New() *Engine

New is the constructor of gout.Engine

func (*Engine) LoadHTMLGlob ¶

func (engine *Engine) LoadHTMLGlob(pattern string)

func (*Engine) Run ¶

func (engine *Engine) Run(addr string) (err error)

Run defines the method to add POST request

func (*Engine) ServeHTTP ¶

func (engine *Engine) ServeHTTP(w http.ResponseWriter, req *http.Request)

func (*Engine) SetFuncMap ¶

func (engine *Engine) SetFuncMap(funcMap template.FuncMap)

type H ¶

type H map[string]any

type HandlerFunc ¶

type HandlerFunc func(c *Context)

HandlerFunc defines the request handler used by gout

func Logger ¶

func Logger() HandlerFunc

func Recovery ¶

func Recovery() HandlerFunc

type RouterGroup ¶

type RouterGroup struct {
	// contains filtered or unexported fields
}

RouterGroup implement the group routes

func (*RouterGroup) GET ¶

func (group *RouterGroup) GET(pattern string, handler HandlerFunc)

GET define the method to add GET request

func (*RouterGroup) Group ¶

func (group *RouterGroup) Group(prefix string) *RouterGroup

Group is defined to create a new RouterGroup remember all groups share the same Engine instance

func (*RouterGroup) POST ¶

func (group *RouterGroup) POST(pattern string, handler HandlerFunc)

POST defines the method to add POST request

func (*RouterGroup) Static ¶

func (group *RouterGroup) Static(relativePath string, root string)

Static is serve static files

func (*RouterGroup) Use ¶

func (group *RouterGroup) Use(middleware ...HandlerFunc)

Use is defined to add middleware to the group

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL