server

Documentation

Index

• Variables
• type Options
  • func (o Options) UsePlanIdMiddleware() bool
• type Server
  • func CreateServer(options Options) Server
  • func (s *Server) AddMiddleware(middleware gin.HandlerFunc)
  • func (s *Server) AddRoute(route api.ApiRoute)
  • func (s *Server) AddRoutes(routes []api.ApiRoute)
  • func (s *Server) AddSubscription(route api.EventRoute)
  • func (s *Server) AddSubscriptions(routes []api.EventRoute)
  • func (s *Server) Init(options Options)
  • func (s *Server) Start(port int)

Variables

var AuthMiddleware = middleware.Auth

Types

type Options

type Options struct {
	// Deprecated: use NoPlanIdMiddleWare instead
	NoTrustFundMiddleware     bool
	NoPlanIdMiddleware        bool
	NoIntegrationIdMiddleware bool
	HealthChecks              health.Config
	PubsubName                string
}

func (Options) UsePlanIdMiddleware

func (o Options) UsePlanIdMiddleware() bool

type Server

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

func CreateServer

func CreateServer(options Options) Server

func (*Server) AddMiddleware

func (s *Server) AddMiddleware(middleware gin.HandlerFunc)

func (*Server) AddRoute

func (s *Server) AddRoute(route api.ApiRoute)

func (*Server) AddRoutes

func (s *Server) AddRoutes(routes []api.ApiRoute)

func (*Server) AddSubscription

func (s *Server) AddSubscription(route api.EventRoute)

func (*Server) AddSubscriptions

func (s *Server) AddSubscriptions(routes []api.EventRoute)

func (*Server) Init

func (s *Server) Init(options Options)

func (*Server) Start

func (s *Server) Start(port int)