router

Documentation

Index

• Variables
• func HandleWithCode(handler interface{}, code int) gin.HandlerFunc
• func Handler(handler interface{}) gin.HandlerFunc
• type Option
  • func WithMiddleware(middleware ...gin.HandlerFunc) Option
• type Router
  • func New(info *openapi.Info, opts ...Option) *Router
  • 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")

Functions

func HandleWithCode

func HandleWithCode(handler interface{}, code int) gin.HandlerFunc

func Handler

func Handler(handler interface{}) gin.HandlerFunc

Types

type Option

type Option func(*gin.Engine)

func WithMiddleware

func WithMiddleware(middleware ...gin.HandlerFunc) Option

type Router

type Router struct {
	*fizz.Fizz
	// contains filtered or unexported fields
}

func New

func New(info *openapi.Info, opts ...Option) *Router

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.