restapi

Documentation

Index

• Variables
• type ParametersRestAPI
• type RestRouteManager
  • func (p *RestRouteManager) AddProxyRoute(route string, host string, port uint32, path string) error
  • func (p *RestRouteManager) AddRoute(route string) *echo.Group
  • func (p *RestRouteManager) RemoveRoute(route string)
  • func (p *RestRouteManager) Routes() []string
• type RoutesResponse

Variables

var (
	Component *app.Component
)

var ParamsRestAPI = &ParametersRestAPI{
	PublicRoutes: []string{
		"/health",
		"/api/routes",
		"/api/core/v2/info",
		"/api/core/v2/tips",
		"/api/core/v2/blocks*",
		"/api/core/v2/transactions*",
		"/api/core/v2/milestones*",
		"/api/core/v2/outputs*",
		"/api/core/v2/treasury",
		"/api/core/v2/receipts*",
		"/api/debug/v1/*",
		"/api/indexer/v1/*",
		"/api/mqtt/v1",
		"/api/participation/v1/events*",
		"/api/participation/v1/outputs*",
		"/api/participation/v1/addresses*",
		"/api/core/v0/*",
		"/api/core/v1/*",
	},
	ProtectedRoutes: []string{
		"/api/*",
	},
}

Types

type ParametersRestAPI

type ParametersRestAPI struct {
	// Enabled defines whether the REST API plugin is enabled.
	Enabled bool `default:"true" usage:"whether the REST API plugin is enabled"`
	// the bind address on which the REST API listens on
	BindAddress string `default:"0.0.0.0:14265" usage:"the bind address on which the REST API listens on"`
	// the HTTP REST routes which can be called without authorization. Wildcards using * are allowed
	PublicRoutes []string `usage:"the HTTP REST routes which can be called without authorization. Wildcards using * are allowed"`
	// the HTTP REST routes which need to be called with authorization. Wildcards using * are allowed
	ProtectedRoutes []string `usage:"the HTTP REST routes which need to be called with authorization. Wildcards using * are allowed"`
	// UseGZIP defines whether to use the gzip middleware to compress HTTP responses
	UseGZIP bool `default:"true" usage:"use the gzip middleware to compress HTTP responses"`
	// whether the debug logging for requests should be enabled
	DebugRequestLoggerEnabled bool `default:"false" usage:"whether the debug logging for requests should be enabled"`

	JWTAuth struct {
		// salt used inside the JWT tokens for the REST API. Change this to a different value to invalidate JWT tokens not matching this new value
		Salt string `` /* 160-byte string literal not displayed */
	} `name:"jwtAuth"`

	PoW struct {
		// whether the node does PoW if blocks are received via API
		Enabled bool `default:"false" usage:"whether the node does PoW if blocks are received via API"`
		// the amount of workers used for calculating PoW when issuing blocks via API
		WorkerCount int `default:"1" usage:"the amount of workers used for calculating PoW when issuing blocks via API"`
	} `name:"pow"`

	Limits struct {
		// the maximum number of characters that the body of an API call may contain
		MaxBodyLength string `default:"1M" usage:"the maximum number of characters that the body of an API call may contain"`
		// the maximum number of results that may be returned by an endpoint
		MaxResults int `default:"1000" usage:"the maximum number of results that may be returned by an endpoint"`
	}
}

ParametersRestAPI contains the definition of the parameters used by REST API.

type RestRouteManager

type RestRouteManager struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func (*RestRouteManager) AddProxyRoute

func (p *RestRouteManager) AddProxyRoute(route string, host string, port uint32, path string) error

AddProxyRoute adds a proxy route to the Routes endpoint and configures a remote proxy for this route.

func (*RestRouteManager) AddRoute

func (p *RestRouteManager) AddRoute(route string) *echo.Group

AddRoute adds a route to the Routes endpoint and returns group to be used to register endpoints.

func (*RestRouteManager) RemoveRoute

func (p *RestRouteManager) RemoveRoute(route string)

RemoveRoute removes a route from the Routes endpoint.

func (*RestRouteManager) Routes

func (p *RestRouteManager) Routes() []string

type RoutesResponse

type RoutesResponse struct {
	Routes []string `json:"routes"`
}