ginruntime

Documentation

Index

• Constants
• func ErrorHandler() gin.HandlerFunc
• type ApiError
  • func BadRequest(reason string) *ApiError
  • func FailedDependency(reason string) *ApiError
  • func Forbidden(reason string) *ApiError
  • func InternalServerError(reason string) *ApiError
  • func Normalize(err error) *ApiError
  • func NotFound(reason string) *ApiError
  • func NotImplemented(reason string) *ApiError
  • func Unauthorized(reason string) *ApiError
  • func UnprocessableEntity(reason string) *ApiError
  • func (this *ApiError) Error() string
• type GinEngine
  • func NewGinEngine() *GinEngine
  • func (e *GinEngine) AddRoute(group *gin.RouterGroup, path string, method int, handlers ...gin.HandlerFunc)
  • func (e *GinEngine) NewGroup(path string, handlers ...gin.HandlerFunc) *gin.RouterGroup
  • func (e *GinEngine) ServerHttp(recorder *httptest.ResponseRecorder, request *http.Request)
  • func (e *GinEngine) StartServer(ctx context.Context, tracing bool)
  • func (e *GinEngine) Use(middleware ...gin.HandlerFunc)

Constants

const (
	GET = iota
	POST
	PUT
	PATCH
	DELETE
)

Exporting constants to avoid hardcoding these all over, and ending up with a uppercase "POST" bug in the future.

Functions

func ErrorHandler

func ErrorHandler() gin.HandlerFunc

Types

type ApiError

type ApiError struct {
	Status int
	Reason string
	Detail error
}

Server response status code and associated error message

func BadRequest

func BadRequest(reason string) *ApiError

func FailedDependency

func FailedDependency(reason string) *ApiError

func Forbidden

func Forbidden(reason string) *ApiError

func InternalServerError

func InternalServerError(reason string) *ApiError

func Normalize

func Normalize(err error) *ApiError

Converts `err` to an `*ApiError` if it's not nil.

func NotFound

func NotFound(reason string) *ApiError

func NotImplemented

func NotImplemented(reason string) *ApiError

func Unauthorized

func Unauthorized(reason string) *ApiError

func UnprocessableEntity

func UnprocessableEntity(reason string) *ApiError

func (*ApiError) Error

func (this *ApiError) Error() string

type GinEngine

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

func NewGinEngine

func NewGinEngine() *GinEngine

func (*GinEngine) AddRoute

func (e *GinEngine) AddRoute(group *gin.RouterGroup, path string, method int, handlers ...gin.HandlerFunc)

AddRoute Add a new endpoint mapping

func (*GinEngine) NewGroup

func (e *GinEngine) NewGroup(path string, handlers ...gin.HandlerFunc) *gin.RouterGroup

func (*GinEngine) ServerHttp

func (e *GinEngine) ServerHttp(recorder *httptest.ResponseRecorder, request *http.Request)

Used for unit testing

func (*GinEngine) StartServer

func (e *GinEngine) StartServer(ctx context.Context, tracing bool)

func (*GinEngine) Use

func (e *GinEngine) Use(middleware ...gin.HandlerFunc)

Adds middleware