api

Documentation

Index

• func Handlers(lock *sync.RWMutex, cfg *config.APIMode, shutdown chan os.Signal, ...) fasthttp.RequestHandler
• func NewHandlerUpdater(lock *sync.RWMutex, logger *logrus.Logger, ...) updater.Updater
• type App
  • func NewApp(lock *sync.RWMutex, passOPTIONS bool, storedSpecs database.DBOpenAPILoader, ...) *App
  • func (a *App) APIModeMainHandler(ctx *fasthttp.RequestCtx)
  • func (a *App) Handle(schemaID int, method string, path string, handler router.Handler, ...) error
  • func (a *App) SignalShutdown()
• type Health
  • func (h *Health) Liveness(ctx *fasthttp.RequestCtx) error
  • func (h *Health) Readiness(ctx *fasthttp.RequestCtx) error
• type RequestValidator
  • func (s *RequestValidator) Handler(ctx *fasthttp.RequestCtx) error
• type Specification
  • func (s *Specification) Find(rctx *router.Context, schemaID int, method, path string) (router.Handler, error)
  • func (s *Specification) Load() (database.DBOpenAPILoader, error)
  • func (s *Specification) Run()
  • func (s *Specification) Shutdown() error
  • func (s *Specification) Start() error

Functions

func Handlers

func Handlers(lock *sync.RWMutex, cfg *config.APIMode, shutdown chan os.Signal, logger *logrus.Logger, storedSpecs database.DBOpenAPILoader, AllowedIPCache *allowiplist.AllowedIPsType, waf coraza.WAF) fasthttp.RequestHandler

func NewHandlerUpdater

func NewHandlerUpdater(lock *sync.RWMutex, logger *logrus.Logger, sqlLiteStorage database.DBOpenAPILoader, cfg *config.APIMode, api *fasthttp.Server, shutdown chan os.Signal, health *Health, allowedIPCache *allowiplist.AllowedIPsType, waf coraza.WAF) updater.Updater

NewHandlerUpdater function defines configuration updater controller

Types

type App

type App struct {
	Routers map[int]*router.Mux
	Log     *logrus.Logger
	// contains filtered or unexported fields
}

App is the entrypoint into our application and what configures our context object for each of our http handlers. Feel free to add any configuration data/logic on this App struct

func NewApp

func NewApp(lock *sync.RWMutex, passOPTIONS bool, storedSpecs database.DBOpenAPILoader, shutdown chan os.Signal, logger *logrus.Logger, mw ...web.Middleware) *App

NewApp creates an App value that handle a set of routes for the set of application.

func (*App) APIModeMainHandler

func (a *App) APIModeMainHandler(ctx *fasthttp.RequestCtx)

APIModeMainHandler routes request to the appropriate handler according to the OpenAPI specification schema ID

func (*App) Handle

func (a *App) Handle(schemaID int, method string, path string, handler router.Handler, mw ...web.Middleware) error

Handle is our mechanism for mounting Handlers for a given HTTP verb and path pair, this makes for really easy, convenient routing.

func (*App) SignalShutdown

func (a *App) SignalShutdown()

SignalShutdown is used to gracefully shutdown the app when an integrity issue is identified.

type Health

type Health struct {
	Build     string
	Logger    *logrus.Logger
	OpenAPIDB database.DBOpenAPILoader
}

func (*Health) Liveness

func (h *Health) Liveness(ctx *fasthttp.RequestCtx) error

Liveness returns simple status info if the service is alive. If the app is deployed to a Kubernetes cluster, it will also return pod, node, and namespace details via the Downward API. The Kubernetes environment variables need to be set within your Pod/Deployment manifest.

func (*Health) Readiness

func (h *Health) Readiness(ctx *fasthttp.RequestCtx) error

Readiness checks if the Fasthttp connection pool is ready to handle new requests.

type RequestValidator

type RequestValidator struct {
	CustomRoute   *loader.CustomRoute
	OpenAPIRouter *loader.Router
	Log           *logrus.Logger
	Cfg           *config.APIMode
	ParserPool    *fastjson.ParserPool
	SchemaID      int
}

func (*RequestValidator) Handler

func (s *RequestValidator) Handler(ctx *fasthttp.RequestCtx) error

Handler validates request and respond with 200, 403 (with error) or 500 status code

type Specification

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

func (*Specification) Find

func (s *Specification) Find(rctx *router.Context, schemaID int, method, path string) (router.Handler, error)

Find function searches for the handler by path and method

func (*Specification) Load

func (s *Specification) Load() (database.DBOpenAPILoader, error)

Load function reads DB file and returns it

func (*Specification) Run

func (s *Specification) Run()

Run function performs update of the specification

func (*Specification) Shutdown

func (s *Specification) Shutdown() error

Shutdown function stops update process

func (*Specification) Start

func (s *Specification) Start() error

Start function starts update process every ConfigurationUpdatePeriod