api

Documentation

Index

• func Setup(b *Builder) *gin.Engine
• type Builder

Functions

func Setup

func Setup(b *Builder) *gin.Engine

Setup configures the API and returns the underlying gin.Engine to allow the caller to start the server additional configuration (e.g. TLS, Ports, Sockets)

Types

type Builder

type Builder struct {
	Redis  *redis.Client
	Logger *zap.Logger
	// Engine is optional, if not provided it with be initialised with gin.New()
	Engine *gin.Engine
}

Builder is a container for the high level services required for running the API service.