ginruntime

Documentation

Index

• Constants
• func ErrorHandler() gin.HandlerFunc
• func GetStack() (GoRoutine, []Frame)
• func IsRunningAsLambda() bool
• func RecoveryMiddleware(c *gin.Context)
• func StackTraceMarshaller(err error) any
• 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 Frame
• type GinEngine
  • func New(ctx context.Context, options ...Option) *GinEngine
  • func (e *GinEngine) AddRoute(group *gin.RouterGroup, path string, method int, ...)
  • func (e *GinEngine) LoadHTLMGlob(path string, funcMap template.FuncMap)
  • func (e *GinEngine) NewGroup(path string, handlers ...gin.HandlerFunc) *gin.RouterGroup
  • func (e *GinEngine) OnShutdown(f func())
  • func (e *GinEngine) OpenAPIEnabled() bool
  • func (e *GinEngine) ServerHttp(recorder *httptest.ResponseRecorder, request *http.Request)
  • func (e *GinEngine) StartServer()
  • func (e *GinEngine) StaticDirectory(path string)
  • func (e *GinEngine) TracingEnabled() bool
  • func (e *GinEngine) Use(middleware ...gin.HandlerFunc)
• type GoRoutine
• type OpenAPIOptions
• type Option
  • func WithOpenAPI(service string, version string, description string, swaggerUiDistUrl string, ...) Option
  • func WithTracing(service string, tp *trace.TracerProvider, ...) Option
  • func WithXRayTracing(service string) Option
• type StackTrace
  • func (s StackTrace) Error() string
  • func (s StackTrace) Skip(n int) StackTrace
  • func (s StackTrace) SkipFramesAfterPanic() StackTrace
• type TracingOptions

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

func GetStack

func GetStack() (GoRoutine, []Frame)

Extracts the current goroutine and stack. The stack includes the `GetStack` function call and its call to `debug.Stack()`.

func IsRunningAsLambda

func IsRunningAsLambda() bool

func RecoveryMiddleware

func RecoveryMiddleware(c *gin.Context)

Gin middleware for recovering from panics and logging to zerolog. Assumes `StackTraceMarshaller` is being used.

Usage:
```go
	engine.Use(RecoveryMiddleware)
```

func StackTraceMarshaller

func StackTraceMarshaller(err error) any

Extracts stack trace from a `StackTrace` error and returns it Usage: ```go zerolog.ErrorStackMarshaler = StackTraceMarshaller goroutine, stack := GetStack() stacktrace := StackTrace{GoRoutine: goroutine, Stack: stack, Reason: r} log.Info().Err(stacktrace).Msg("An error occurred") ```

Types

type ApiError

type ApiError struct {
	Detail error
	Reason string
	Status int
}

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 Frame

type Frame struct {
	File     string
	Line     string
	Function string
}

type GinEngine

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

func New

func New(ctx context.Context, options ...Option) *GinEngine

func (*GinEngine) AddRoute

func (e *GinEngine) AddRoute(group *gin.RouterGroup, path string, method int, annotations openapi.Annotations, handler ...gin.HandlerFunc)

AddRoute Add a new endpoint mapping

func (*GinEngine) LoadHTLMGlob

func (e *GinEngine) LoadHTLMGlob(path string, funcMap template.FuncMap)

func (*GinEngine) NewGroup

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

func (*GinEngine) OnShutdown

func (e *GinEngine) OnShutdown(f func())

func (*GinEngine) OpenAPIEnabled

func (e *GinEngine) OpenAPIEnabled() bool

func (*GinEngine) ServerHttp

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

Used for unit testing

func (*GinEngine) StartServer

func (e *GinEngine) StartServer()

func (*GinEngine) StaticDirectory

func (e *GinEngine) StaticDirectory(path string)

func (*GinEngine) TracingEnabled

func (e *GinEngine) TracingEnabled() bool

func (*GinEngine) Use

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

Adds middleware

type GoRoutine

type GoRoutine = string

type OpenAPIOptions

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

type Option

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

func WithOpenAPI

func WithOpenAPI(
	service string,
	version string,
	description string,
	swaggerUiDistUrl string,
	middleware ...gin.HandlerFunc,
) Option

Enables OpenAPI endpoint `/openapi.json` and Swagger UI endpoint `/docs`.

Routes must be annotated with `openapi.Annotate` to be included in the OpenAPI spec.

The `/docs` endpoint uses `swaggerUiDistUrl` to load JavaScript and CSS for Swagger UI. See here for more information: https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/installation.md

func WithTracing

func WithTracing(
	service string,
	tp *trace.TracerProvider,
	propagator propagation.TextMapPropagator,
) Option

Configures OpenTelemetry for tracing and adds a middleware that traces incoming requests.

func WithXRayTracing

func WithXRayTracing(
	service string,
) Option

Configures OpenTelemetry for tracing that integrates with AWS X-Ray and adds a middleware that traces incoming requests.

type StackTrace

type StackTrace struct {
	GoRoutine string
	Stack     []Frame
	Reason    any
}

func (StackTrace) Error

func (s StackTrace) Error() string

func (StackTrace) Skip

func (s StackTrace) Skip(n int) StackTrace

func (StackTrace) SkipFramesAfterPanic

func (s StackTrace) SkipFramesAfterPanic() StackTrace

type TracingOptions

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