gofr

Nov 27, 2024

Changes in this version

type App

+ func (a *App) AddOpenTSDB(db container.OpenTSDBProvider)

Nov 15, 2024

Changes in this version

type App

+ func (a *App) UseMiddlewareWithContainer(...)

Nov 7, 2024

Changes in this version

type Context

+ Out terminal.Output

Nov 4, 2024

Changes in this version

+ type AuthInfo interface

+ GetAPIKey func() string

+ GetClaims func() jwt.MapClaims

+ GetUsername func() string

type Context

+ func (c *Context) GetAuthInfo() AuthInfo

Oct 1, 2024

Changes in this version

type App

+ func (a *App) AddPubSub(pubsub container.PubSubProvider)

Sep 23, 2024

Changes in this version

type App

+ func (a *App) AddDgraph(db container.DgraphProvider)

Sep 16, 2024

Changes in this version

type App

+ func (a *App) AddSolr(db container.SolrProvider)

Sep 2, 2024

Changes in this version

type App

+ func (a *App) AddFileStore(fs file.FileSystemProvider)

Aug 26, 2024

Changes in this version

+ type ErrorLogEntry struct

+ Error string

+ TraceID string

+ func (el *ErrorLogEntry) PrettyPrint(writer io.Writer)

Aug 12, 2024

Changes in this version

+ var ErrMarshalingResponse = errors.New("error marshaling response")

type App

+ func (a *App) AddFTP(fs file.FileSystemProvider)

type Context

+ func (c *Context) WriteMessageToSocket(data any) error

Aug 5, 2024

Changes in this version

+ func ShutdownWithContext(ctx context.Context, shutdownFunc func(ctx context.Context) error, ...) error

type App

+ func (a *App) Shutdown(ctx context.Context) error

type Request

+ Params func(string) []string

Jul 22, 2024

Changes in this version

type App

+ func (a *App) AddKVStore(db container.KVStoreProvider)

Jun 28, 2024

Changes in this version

type App

+ func (a *App) AddStaticFiles(endpoint, filePath string)

Jun 21, 2024

Changes in this version

type App

+ func (a *App) EnableAPIKeyAuthWithValidator(validateFunc func(c *container.Container, apiKey string) bool)

+ func (a *App) EnableBasicAuthWithValidator(validateFunc func(c *container.Container, username, password string) bool)

Jun 18, 2024

Changes in this version

type App

+ func (a *App) AddClickhouse(db datasource.ClickhouseProvider)

+ func (a *App) OverrideWebsocketUpgrader(wsUpgrader websocket.Upgrader)

+ func (a *App) WebSocket(route string, handler Handler)

Jun 11, 2024

Changes in this version

type App

+ func (a *App) AddCassandra(db datasource.CassandraProvider)

+ type Options func(c *route)

+ func AddDescription(descString string) Options

+ func AddHelp(helperString string) Options

May 28, 2024

Changes in this version

+ type RestPathOverrider interface

+ RestPath func() string

+ type TableNameOverrider interface

+ TableName func() string

May 27, 2024

Changes in this version

type App

+ func (a *App) AddMongo(db datasource.MongoProvider)

May 14, 2024

Changes in this version

type App

+ func (a *App) PATCH(pattern string, handler Handler)

May 12, 2024

Changes in this version

+ const OpenAPIJSON

type App

+ func (a *App) AddCronJob(schedule, jobName string, job CronFunc)

+ type CronFunc func(ctx *Context)

May 2, 2024

Changes in this version

type App

+ func (a *App) UseMiddleware(middlewares ...gofrHTTP.Middleware)

Apr 20, 2024

Changes in this version

+ type Exporter struct

+ func NewExporter(endpoint string, logger logging.Logger) *Exporter

+ func (e *Exporter) ExportSpans(ctx context.Context, spans []sdktrace.ReadOnlySpan) error

+ func (e *Exporter) Shutdown(context.Context) error

+ type Span struct

+ Duration int64

+ ID string

+ LocalEndpoint map[string]string

+ Name string

+ ParentID string

+ Tags map[string]string

+ Timestamp int64

+ TraceID string

Apr 6, 2024

Changes in this version

type App

+ func (a *App) AddRESTHandlers(object interface{}) error

+ func (a *App) Logger() logging.Logger

+ func (a *App) UseMongo(db datasource.Mongo)

+ type CRUD interface

+ type Create interface

+ Create func(c *Context) (interface{}, error)

+ type Delete interface

+ Delete func(c *Context) (interface{}, error)

+ type Get interface

+ Get func(c *Context) (interface{}, error)

+ type GetAll interface

+ GetAll func(c *Context) (interface{}, error)

+ type Update interface

+ Update func(c *Context) (interface{}, error)

Mar 14, 2024

Changes in this version

type App

+ func (a *App) EnableAPIKeyAuth(apiKeys ...string)

+ func (a *App) EnableAPIKeyAuthWithFunc(validator func(apiKey string) bool)

+ func (a *App) EnableBasicAuth(credentials ...string)

+ func (a *App) EnableBasicAuthWithFunc(validateFunc func(username, password string) bool)

+ func (a *App) EnableOAuth(jwksEndpoint string, refreshInterval int)

+ func (a *App) Subscribe(topic string, handler SubscribeFunc)

+ type SubscribeFunc func(c *Context) error

+ type SubscriptionManager struct

Oct 24, 2023

Changes in this version

+ const DefaultFilterCondition

+ const IdleTimeOut

+ const ReadTimeOut

+ const WriteTimeOut

+ var ErrBadCronFormat = errors.New("schedule string must have five components like * * * * *")

+ func HealthHandler(c *Context) (interface{}, error)

+ func HeartBeatHandler(*Context) (interface{}, error)

+ func InitializeAWSSNSFromConfigs(c Config, prefix string) (notifier.Notifier, error)

+ func InitializeCassandraFromConfigs(c Config, l log.Logger, prefix string) (datastore.Cassandra, error)

+ func InitializeDynamoDBFromConfig(c Config, l log.Logger, prefix string) (datastore.DynamoDB, error)

+ func InitializeElasticSearchFromConfigs(c Config, l log.Logger, prefix string) (datastore.Elasticsearch, error)

+ func InitializeGORMFromConfigs(c Config, prefix string) (datastore.GORMClient, error)

+ func InitializeMongoDBFromConfigs(c Config, l log.Logger, prefix string) (datastore.MongoDB, error)

+ func InitializePubSubFromConfigs(c Config, l log.Logger, prefix string) (pubsub.PublisherSubscriber, error)

+ func InitializeRedisFromConfigs(c Config, l log.Logger, prefix string) (datastore.Redis, error)

+ func InitializeSQLFromConfigs(c Config, prefix string) (*datastore.SQLClient, error)

+ func InitializeSolrFromConfigs(c Config, prefix string) (datastore.Client, error)

+ func InitializeYCQLFromConfigs(c Config, l log.Logger, prefix string) (datastore.YCQL, error)

+ func LoggingInterceptor(logger log.Logger) grpc.UnaryServerInterceptor

+ func NewGRPCServer() *grpc.Server

+ func NewServer(c Config, gofr *Gofr) *server

+ func OpenAPIHandler(*Context) (interface{}, error)

+ func SwaggerUIHandler(c *Context) (interface{}, error)

+ type CMDRouter struct

+ func NewCMDRouter() CMDRouter

+ func (r *CMDRouter) AddRoute(pattern string, handler Handler)

+ type Config interface

+ Get func(string) string

+ GetOrDefault func(string, string) string

type Context

+ Logger log.Logger

+ ServerFlush http.Flusher

+ ServerPush http.Pusher

+ WebSocketConnection *websocket.Conn

+ func NewContext(w responder.Responder, r request.Request, k *Gofr) *Context

+ func (c *Context) BindStrict(i interface{}) error

+ func (c *Context) Filters() Filters

+ func (c *Context) GetClaim(claimKey string) interface{}

+ func (c *Context) GetClaims() map[string]interface{}

+ func (c *Context) Header(key string) string

+ func (c *Context) Log(key string, value interface{})

+ func (c *Context) Param(key string) string

+ func (c *Context) Params() map[string]string

+ func (c *Context) PathParam(key string) string

+ func (c *Context) Projections(resource string) (ProjectionMapType, error)

+ func (c *Context) PublishEvent(key string, value interface{}, headers map[string]string) error

+ func (c *Context) PublishEventWithOptions(key string, value interface{}, headers map[string]string, ...) error

+ func (c *Context) Request() *http.Request

+ func (c *Context) SetPathParams(pathParams map[string]string)

+ func (c *Context) Subscribe(target interface{}) (*pubsub.Message, error)

+ func (c *Context) SubscribeWithCommit(f pubsub.CommitFunc) (*pubsub.Message, error)

+ func (c *Context) ValidateClaimSub(subject string) bool

+ func (c *Context) ValidateClaimsPFCX(pfcx string) bool

+ func (c *Context) ValidateClaimsScope(scope string) bool

+ type Crontab struct

+ func NewCron() *Crontab

+ func (c *Crontab) AddJob(schedule string, fn func()) error

+ type Filter map[string]string

+ type Filters map[string]Filter

+ type GRPC struct

+ Port int

+ func (g *GRPC) Server() *grpc.Server

+ func (g *GRPC) Start(logger log.Logger)

+ type Gofr struct

+ Config Config

+ DatabaseHealth []HealthCheck

+ Logger log.Logger

+ Metric metrics.Metric

+ Notifier notifier.Notifier

+ ResourceCustomShapes map[string][]string

+ ResourceMap map[string][]string

+ Server *server

+ ServiceHealth []HealthCheck

+ TemplateDir string

+ func NewWithConfig(c Config) (k *Gofr)

+ func (k *Gofr) DELETE(path string, handler Handler)

+ func (k *Gofr) EnableSwaggerUI()

+ func (k *Gofr) GET(path string, handler Handler)

+ func (k *Gofr) NewCounter(name, help string, labels ...string) error

+ func (k *Gofr) NewGauge(name, help string, labels ...string) error

+ func (k *Gofr) NewHistogram(name, help string, buckets []float64, labels ...string) error

+ func (k *Gofr) NewSummary(name, help string, labels ...string) error

+ func (k *Gofr) PATCH(path string, handler Handler)

+ func (k *Gofr) POST(path string, handler Handler)

+ func (k *Gofr) PUT(path string, handler Handler)

+ func (k *Gofr) REST(entity string, handler interface{})

+ func (k *Gofr) Start()

+ type HTTP struct

+ Port int

+ RedirectToHTTPS bool

+ type HTTPS struct

+ CertificateFile string

+ KeyFile string

+ Port int

+ TLSConfig *tls.Config

+ func (h *HTTPS) StartServer(logger log.Logger, router http.Handler)

type Handler

+ func (h Handler) ServeHTTP(_ http.ResponseWriter, r *http.Request)

+ type HealthCheck func() types.Health

+ type Middleware func(http.Handler) http.Handler

+ type ProjectionMapType map[string]string

+ type RPCLog struct

+ Duration int64

+ ID string

+ Method string

+ ResponseTime int64

+ StartTime string

+ URI string

+ func (l *RPCLog) String() string

+ type RestCreator interface

+ Create func(c *Context) (interface{}, error)

+ type RestDeleter interface

+ Delete func(c *Context) (interface{}, error)

+ type RestIndexer interface

+ Index func(c *Context) (interface{}, error)

+ type RestPatcher interface

+ Patch func(c *Context) (interface{}, error)

+ type RestReader interface

+ Read func(c *Context) (interface{}, error)

+ type RestUpdater interface

+ Update func(c *Context) (interface{}, error)

+ type Router interface

+ CatchAllRoute func(h Handler)

+ Prefix func(prefix string)

+ Route func(method string, path string, handler Handler)

+ Use func(...Middleware)

+ func NewRouter() Router

Feb 19, 2024

Changes in this version

type App

+ func (a *App) Migrate(migrationsMap map[int64]migration.Migrate)

Feb 9, 2024

Changes in this version

type App

+ func (a *App) Metrics() metrics.Manager

Jan 22, 2024

Changes in this version

+ type App struct

+ Config config.Config

+ func New() *App

+ func NewCMD() *App

+ func (a *App) AddHTTPService(serviceName, serviceAddress string)

+ func (a *App) DELETE(pattern string, handler Handler)

+ func (a *App) GET(pattern string, handler Handler)

+ func (a *App) POST(pattern string, handler Handler)

+ func (a *App) PUT(pattern string, handler Handler)

+ func (a *App) RegisterService(desc *grpc.ServiceDesc, impl interface{})

+ func (a *App) Run()

+ func (a *App) SubCommand(pattern string, handler Handler)

+ type Context struct

+ func (c *Context) Bind(i interface{}) error

+ func (c *Context) Trace(name string) trace.Span

+ type ErrCommandNotFound struct

+ func (e ErrCommandNotFound) Error() string

+ type Handler func(c *Context) (interface{}, error)

+ type Request interface

+ Bind func(interface{}) error

+ Context func() context.Context

+ HostName func() string

+ Param func(string) string

+ PathParam func(string) string

+ type Responder interface

+ Respond func(data interface{}, err error)