router

Documentation

Index

• Variables
• type Context
  • func (c *Context) Abort(err Error)
  • func (c *Context) AbortWithCode(code int, err Error)
  • func (c *Context) AbortWithError(statusCode int, err Error)
  • func (c *Context) BadRequest(err Error)
  • func (c *Context) Conflict(err Error)
  • func (c *Context) Created()
  • func (c *Context) JSON(data interface{})
  • func (c *Context) NotFound(err Error)
  • func (c *Context) NotModified()
  • func (c *Context) OK()
  • func (c *Context) ParseBody(obj interface{}) error
  • func (c *Context) Unauthorized(err Error)
  • func (c *Context) Unprocessable(err Error)
• type ErrCode
• type Error
  • func (e Error) Error() string
• type Group
  • func (g *Group) Any(path string, handlers ...HandlerFunc)
  • func (g *Group) DELETE(path string, handlers ...HandlerFunc)
  • func (g *Group) GET(path string, handlers ...HandlerFunc)
  • func (g *Group) Group(path string, handlers ...HandlerFunc) *Group
  • func (g *Group) HEAD(path string, handlers ...HandlerFunc)
  • func (g *Group) OPTIONS(path string, handlers ...HandlerFunc)
  • func (g *Group) PATCH(path string, handlers ...HandlerFunc)
  • func (g *Group) POST(path string, handlers ...HandlerFunc)
  • func (g *Group) PUT(path string, handlers ...HandlerFunc)
• type HandlerFunc
• type Router
  • func New() *Router
  • func (r *Router) Any(path string, handlers ...HandlerFunc)
  • func (r *Router) DELETE(path string, handlers ...HandlerFunc)
  • func (r *Router) GET(path string, handlers ...HandlerFunc)
  • func (r *Router) Group(path string, handlers ...HandlerFunc) *Group
  • func (r *Router) HEAD(path string, handlers ...HandlerFunc)
  • func (r *Router) Handle(method, path string, handlers ...HandlerFunc)
  • func (r *Router) OPTIONS(path string, handlers ...HandlerFunc)
  • func (r *Router) PATCH(path string, handlers ...HandlerFunc)
  • func (r *Router) POST(path string, handlers ...HandlerFunc)
  • func (r *Router) PUT(path string, handlers ...HandlerFunc)
  • func (r *Router) Start(addr string) error
  • func (r *Router) Stop(ctx context.Context) error

Variables

var (
	ErrFailedToStopServer = errors.New("failed to stop the server")
)

Types

type Context

type Context struct {
	*gin.Context
}

func (*Context) Abort

func (c *Context) Abort(err Error)

func (*Context) AbortWithCode

func (c *Context) AbortWithCode(code int, err Error)

func (*Context) AbortWithError

func (c *Context) AbortWithError(statusCode int, err Error)

func (*Context) BadRequest

func (c *Context) BadRequest(err Error)

func (*Context) Conflict

func (c *Context) Conflict(err Error)

func (*Context) Created

func (c *Context) Created()

func (*Context) JSON

func (c *Context) JSON(data interface{})

func (*Context) NotFound

func (c *Context) NotFound(err Error)

func (*Context) NotModified

func (c *Context) NotModified()

func (*Context) OK

func (c *Context) OK()

func (*Context) ParseBody

func (c *Context) ParseBody(obj interface{}) error

func (*Context) Unauthorized

func (c *Context) Unauthorized(err Error)

func (*Context) Unprocessable

func (c *Context) Unprocessable(err Error)

type ErrCode

type ErrCode string

const (
	ErrFailedToParseBody ErrCode = "failed_to_parse_body"
)

type Error

type Error struct {
	Code           ErrCode `json:"code"`
	PublicMessage  string  `json:"message,omitempty"`
	PrivateMessage string  `json:"-"`
}

func (Error) Error

func (e Error) Error() string

type Group

type Group struct {
	*gin.RouterGroup
}

func (*Group) Any

func (g *Group) Any(path string, handlers ...HandlerFunc)

func (*Group) DELETE

func (g *Group) DELETE(path string, handlers ...HandlerFunc)

func (*Group) GET

func (g *Group) GET(path string, handlers ...HandlerFunc)

func (*Group) Group

func (g *Group) Group(path string, handlers ...HandlerFunc) *Group

func (*Group) HEAD

func (g *Group) HEAD(path string, handlers ...HandlerFunc)

func (*Group) OPTIONS

func (g *Group) OPTIONS(path string, handlers ...HandlerFunc)

func (*Group) PATCH

func (g *Group) PATCH(path string, handlers ...HandlerFunc)

func (*Group) POST

func (g *Group) POST(path string, handlers ...HandlerFunc)

func (*Group) PUT

func (g *Group) PUT(path string, handlers ...HandlerFunc)

type HandlerFunc

type HandlerFunc func(*Context)

type Router

type Router struct {
	*gin.Engine
	// contains filtered or unexported fields
}

func New

func New() *Router

func (*Router) Any

func (r *Router) Any(path string, handlers ...HandlerFunc)

func (*Router) DELETE

func (r *Router) DELETE(path string, handlers ...HandlerFunc)

func (*Router) GET

func (r *Router) GET(path string, handlers ...HandlerFunc)

func (*Router) Group

func (r *Router) Group(path string, handlers ...HandlerFunc) *Group

func (*Router) HEAD

func (r *Router) HEAD(path string, handlers ...HandlerFunc)

func (*Router) Handle

func (r *Router) Handle(method, path string, handlers ...HandlerFunc)

func (*Router) OPTIONS

func (r *Router) OPTIONS(path string, handlers ...HandlerFunc)

func (*Router) PATCH

func (r *Router) PATCH(path string, handlers ...HandlerFunc)

func (*Router) POST

func (r *Router) POST(path string, handlers ...HandlerFunc)

func (*Router) PUT

func (r *Router) PUT(path string, handlers ...HandlerFunc)

func (*Router) Start

func (r *Router) Start(addr string) error

func (*Router) Stop

func (r *Router) Stop(ctx context.Context) error

Stop gracefully shuts down the server. It will throw ErrFailedToStopServer if the server fails to stop.