app

Documentation

Index

• Constants
• func NewMiddleware(logger *zerolog.Logger) []func(next http.Handler) http.Handler
• func NewMux(a *APIManager, middleware []func(next http.Handler) http.Handler) (http.Handler, error)
• func ProvideLogger(config config.Config) (*zerolog.Logger, error)
• func SetupAPIServer(lifecycle fx.Lifecycle, config config.Config, logger *zerolog.Logger, ...) error
• type APIManager
  • func NewAPIManager(routingMgr tablemgr.RoutingTableManager, tenantStorer tenant.TenantStorer, ...) (*APIManager, error)
• type ApiError
• type BadRequestError
  • func (e *BadRequestError) Error() string
  • func (e *BadRequestError) StatusCode() int
• type InternalServerError
  • func (e *InternalServerError) Error() string
  • func (e *InternalServerError) StatusCode() int
• type InvalidOptionError
  • func (e *InvalidOptionError) Error() string
• type NotFoundError
  • func (e *NotFoundError) Error() string
  • func (e *NotFoundError) StatusCode() int
• type NotImplementedError
  • func (e *NotImplementedError) Error() string
  • func (e *NotImplementedError) StatusCode() int
• type Response
  • func ErrorResponse(apiErr ApiError) Response
  • func ItemResponse(item interface{}) Response
  • func ItemsResponse(item interface{}) Response
  • func SimpleResponse(ctx context.Context) Response
  • func (r Response) Respond(ctx context.Context, w http.ResponseWriter)
• type Status
• type Tenant
  • func NewTenantId(orgId, appId string) *Tenant
  • func (t *Tenant) AppId() string
  • func (t *Tenant) OrgId() string
• type Tracing

Constants

const (
	LogTraceId      = "tx.traceId"
	LogSpanId       = "tx.spanId"
	LogParentSpanId = "tx.parentSpanId"
	LogChildSpanId  = "tx.childSpanId"
	LogTenantId     = "gears.app.id"
)

Logging expected keys

const (
	HeaderTraceId      = "X-B3-TraceId"
	HeaderSpanId       = "X-B3-SpanId"
	HeaderParentSpanId = "X-B3-ParentSpanId"
	HeaderTenantId     = "Application-Id"
)

API header expected keys

Functions

func NewMiddleware

func NewMiddleware(logger *zerolog.Logger) []func(next http.Handler) http.Handler

func NewMux

func NewMux(a *APIManager, middleware []func(next http.Handler) http.Handler) (http.Handler, error)

func ProvideLogger

func ProvideLogger(config config.Config) (*zerolog.Logger, error)

func SetupAPIServer

func SetupAPIServer(lifecycle fx.Lifecycle, config config.Config, logger *zerolog.Logger, mux http.Handler) error

Types

type APIManager

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

func NewAPIManager

func NewAPIManager(routingMgr tablemgr.RoutingTableManager, tenantStorer tenant.TenantStorer, quotaManager *quota.QuotaManager) (*APIManager, error)

type ApiError

type ApiError interface {
	error
	StatusCode() int
}

Rest API errors

type BadRequestError

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

func (*BadRequestError) Error

func (e *BadRequestError) Error() string

func (*BadRequestError) StatusCode

func (e *BadRequestError) StatusCode() int

type InternalServerError

type InternalServerError struct {
	Wrapped error
}

func (*InternalServerError) Error

func (e *InternalServerError) Error() string

func (*InternalServerError) StatusCode

func (e *InternalServerError) StatusCode() int

type InvalidOptionError

type InvalidOptionError struct {
	Option string
}

InvalidOptionError is returned when an invalid option is passed in

func (*InvalidOptionError) Error

func (e *InvalidOptionError) Error() string

type NotFoundError

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

func (*NotFoundError) Error

func (e *NotFoundError) Error() string

func (*NotFoundError) StatusCode

func (e *NotFoundError) StatusCode() int

type NotImplementedError

type NotImplementedError struct {
}

func (*NotImplementedError) Error

func (e *NotImplementedError) Error() string

func (*NotImplementedError) StatusCode

func (e *NotImplementedError) StatusCode() int

type Response

type Response struct {
	Status  *Status  `json:"status,omitempty" xml:"status,omitempty"`
	Tracing *Tracing `json:"tx,omitempty" xml:"tx,omitempty"`

	Item  interface{} `json:"item,omitempty" xml:"item,omitempty"`
	Items interface{} `json:"items,omitempty" xml:"items,omitempty"`
	Data  interface{} `json:"data,omitempty" xml:"data,omitempty"`
}

func ErrorResponse

func ErrorResponse(apiErr ApiError) Response

func ItemResponse

func ItemResponse(item interface{}) Response

func ItemsResponse

func ItemsResponse(item interface{}) Response

func SimpleResponse

func SimpleResponse(ctx context.Context) Response

func (Response) Respond

func (r Response) Respond(ctx context.Context, w http.ResponseWriter)

type Status

type Status struct {
	Code    int    `json:"code,omitempty" xml:"code,omitempty"`
	Message string `json:"message,omitempty" xml:"message,omitempty"`
}

type Tenant

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

func NewTenantId

func NewTenantId(orgId, appId string) *Tenant

func (*Tenant) AppId

func (t *Tenant) AppId() string

func (*Tenant) OrgId

func (t *Tenant) OrgId() string

type Tracing

type Tracing struct {
	TraceId string `json:"traceId,omitempty" xml:"traceId,omitempty"`
	SpanId  string `json:"spanId,omitempty" xml:"spanId,omitempty"`
}