api

Documentation

Index

• func RegisterDefaultValidators() error
• func RegisterRoutes(ws *gin.Engine, routesConfig config.ApiRoutesConfig, ...)
• func Start(elrondFacade MainApiHandler, routesConfig config.ApiRoutesConfig, ...) error
• type MainApiHandler
• type MiddlewareProcessor

Functions

func RegisterDefaultValidators

func RegisterDefaultValidators() error

RegisterDefaultValidators will call register validation on all validator functions

func RegisterRoutes

func RegisterRoutes(ws *gin.Engine, routesConfig config.ApiRoutesConfig, elrondFacade middleware.Handler)

RegisterRoutes will register all routes available on the web server

func Start

func Start(elrondFacade MainApiHandler, routesConfig config.ApiRoutesConfig, processors ...MiddlewareProcessor) error

Start will boot up the api and appropriate routes, handlers and validators

Types

type MainApiHandler

type MainApiHandler interface {
	RestApiInterface() string
	RestAPIServerDebugMode() bool
	PprofEnabled() bool
	IsInterfaceNil() bool
}

MainApiHandler interface defines methods that can be used from `elrondFacade` context variable

type MiddlewareProcessor

type MiddlewareProcessor interface {
	MiddlewareHandlerFunc() gin.HandlerFunc
	IsInterfaceNil() bool
}

MiddlewareProcessor defines a processor used internally by the web server when processing requests