gofr

Documentation

Index

• Constants
• func OpenAPIHandler(c *Context) (interface{}, error)
• func SwaggerUIHandler(c *Context) (interface{}, error)
• type App
  • func New() *App
  • func NewCMD() *App
  • func (a *App) AddCronJob(schedule, jobName string, job CronFunc)
  • func (a *App) AddHTTPService(serviceName, serviceAddress string, options ...service.Options)
  • func (a *App) AddRESTHandlers(object interface{}) error
  • func (a *App) DELETE(pattern string, handler Handler)
  • 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) GET(pattern string, handler Handler)
  • func (a *App) Logger() logging.Logger
  • func (a *App) Metrics() metrics.Manager
  • func (a *App) Migrate(migrationsMap map[int64]migration.Migrate)
  • 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)
  • func (a *App) Subscribe(topic string, handler SubscribeFunc)
  • func (a *App) UseMiddleware(middlewares ...gofrHTTP.Middleware)
  • func (a *App) UseMongo(db datasource.Mongo)
• type CRUD
• type Context
  • func (c *Context) Bind(i interface{}) error
  • func (c *Context) Trace(name string) trace.Span
• type Create
• type CronFunc
• type Crontab
  • func NewCron(cntnr *container.Container) *Crontab
  • func (c *Crontab) AddJob(schedule, jobName string, fn CronFunc) error
• type Delete
• type ErrCommandNotFound
  • func (e ErrCommandNotFound) Error() string
• type Exporter
  • 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 Get
• type GetAll
• type Handler
• type Request
• type Responder
• type Span
• type SubscribeFunc
• type SubscriptionManager
• type Update

Constants

const (
	OpenAPIJSON = "openapi.json"
)

Functions

func OpenAPIHandler

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

OpenAPIHandler serves the `openapi.json` file at the specified path. It reads the file from the disk and returns its content as a response.

func SwaggerUIHandler

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

SwaggerUIHandler serves the static files of the Swagger UI.

Types

type App

type App struct {
	// Config can be used by applications to fetch custom configurations from environment or file.
	Config config.Config // If we directly embed, unnecessary confusion between app.Get and app.GET will happen.
	// contains filtered or unexported fields
}

App is the main application in the gofr framework.

func New

func New() *App

New creates an HTTP Server Application and returns that App.

func NewCMD

func NewCMD() *App

NewCMD creates a command line application.

func (*App) AddCronJob

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

AddCronJob registers a cron job to the cron table, the schedule is in * * * * * (6 part) format denoting minutes, hours, days, months and day of week respectively.

func (*App) AddHTTPService

func (a *App) AddHTTPService(serviceName, serviceAddress string, options ...service.Options)

AddHTTPService registers HTTP service in container.

func (*App) AddRESTHandlers

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

func (*App) DELETE

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

DELETE adds a Handler for http DELETE method for a route pattern.

func (*App) EnableAPIKeyAuth

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

func (*App) EnableAPIKeyAuthWithFunc

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

func (*App) EnableBasicAuth

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

func (*App) EnableBasicAuthWithFunc

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

func (*App) EnableOAuth

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

func (*App) GET

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

GET adds a Handler for http GET method for a route pattern.

func (*App) Logger

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

func (*App) Metrics

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

func (*App) Migrate

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

func (*App) POST

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

POST adds a Handler for http POST method for a route pattern.

func (*App) PUT

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

PUT adds a Handler for http PUT method for a route pattern.

func (*App) RegisterService

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

RegisterService adds a grpc service to the gofr application.

func (*App) Run

func (a *App) Run()

Run starts the application. If it is a HTTP server, it will start the server.

func (*App) SubCommand

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

SubCommand adds a sub-command to the CLI application. Can be used to create commands like "kubectl get" or "kubectl get ingress".

func (*App) Subscribe

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

func (*App) UseMiddleware

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

UseMiddleware is a setter method for adding user defined custom middleware to GoFr's router.

func (*App) UseMongo

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

type CRUD

type CRUD interface {
	Create
	GetAll
	Get
	Update
	Delete
}

type Context

type Context struct {
	context.Context

	// Request needs to be public because handlers need to access request details. Else, we need to provide all
	// functionalities of the Request as a method on context. This is not needed because Request here is an interface
	// So, internals are not exposed anyway.
	Request

	// Same logic as above.
	*container.Container
	// contains filtered or unexported fields
}

func (*Context) Bind

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

func (*Context) Trace

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

Trace returns an open telemetry span. We have to always close the span after corresponding work is done. Usages:

span := c.Trace("Some Work")
// Do some work here.
defer span.End()

If an entire function has to traced as span, we can use a simpler format:

defer c.Trace("ExampleHandler").End()

We can write this at the start of function and because of how defer works, trace will start at that line but End will be called after function ends.

Developer Note: If you chain methods in a defer statement, everything except the last function will be evaluated at call time.

type Create

type Create interface {
	Create(c *Context) (interface{}, error)
}

type CronFunc

type CronFunc func(ctx *Context)

type Crontab

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

Crontab maintains the job scheduling and runs the jobs at their scheduled time by going through them at each tick using a ticker.

func NewCron

func NewCron(cntnr *container.Container) *Crontab

NewCron initializes and returns new cron tab.

func (*Crontab) AddJob

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

AddJob to cron tab, returns error if the cron syntax can't be parsed or is out of bounds.

type Delete

type Delete interface {
	Delete(c *Context) (interface{}, error)
}

type ErrCommandNotFound

type ErrCommandNotFound struct{}

func (ErrCommandNotFound) Error

func (e ErrCommandNotFound) Error() string

type Exporter

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

Exporter is responsible for exporting spans to a remote endpoint.

func NewExporter

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

NewExporter creates a new Exporter instance with a custom endpoint and logger.

func (*Exporter) ExportSpans

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

ExportSpans exports spans to the configured remote endpoint.

func (*Exporter) Shutdown

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

Shutdown shuts down the exporter.

type Get

type Get interface {
	Get(c *Context) (interface{}, error)
}

type GetAll

type GetAll interface {
	GetAll(c *Context) (interface{}, error)
}

type Handler

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

type Request

type Request interface {
	Context() context.Context
	Param(string) string
	PathParam(string) string
	Bind(interface{}) error
	HostName() string
}

Request is an interface which is written because it allows us to create applications without being aware of the transport. In both cmd or server application, this abstraction can be used.

type Responder

type Responder interface {
	Respond(data interface{}, err error)
}

Responder is used by the application to provide output. This is implemented for both cmd and http server application.

type Span

type Span struct {
	TraceID       string            `json:"traceId"`            // Trace ID of the span.
	ID            string            `json:"id"`                 // ID of the span.
	ParentID      string            `json:"parentId,omitempty"` // Parent ID of the span.
	Name          string            `json:"name"`               // Name of the span.
	Timestamp     int64             `json:"timestamp"`          // Timestamp of the span.
	Duration      int64             `json:"duration"`           // Duration of the span.
	Tags          map[string]string `json:"tags,omitempty"`     // Tags associated with the span.
	LocalEndpoint map[string]string `json:"localEndpoint"`      // Local endpoint of the span.
}

Span represents a span that will be exported.

type SubscribeFunc

type SubscribeFunc func(c *Context) error

type SubscriptionManager

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

type Update

type Update interface {
	Update(c *Context) (interface{}, error)
}