api

Documentation

Overview

Package api provides the functionality of the Bee client-facing HTTP API.

Index

• Constants
• type Options
• type Service
  • func New(tags *tags.Tags, storer storage.Storer, resolver resolver.Interface, ...) Service

Constants

const (
	SwarmPinHeader           = "Swarm-Pin"
	SwarmTagHeader           = "Swarm-Tag"
	SwarmEncryptHeader       = "Swarm-Encrypt"
	SwarmIndexDocumentHeader = "Swarm-Index-Document"
	SwarmErrorDocumentHeader = "Swarm-Error-Document"
	SwarmFeedIndexHeader     = "Swarm-Feed-Index"
	SwarmFeedIndexNextHeader = "Swarm-Feed-Index-Next"
)

const (
	// TargetsRecoveryHeader defines the Header for Recovery targets in Global Pinning
	TargetsRecoveryHeader = "swarm-recovery-targets"
)

Types

type Options

type Options struct {
	CORSAllowedOrigins []string
	GatewayMode        bool
	WsPingPeriod       time.Duration
}

type Service

type Service interface {
	http.Handler
	m.Collector
	io.Closer
}

Service is the API service interface.

func New

func New(tags *tags.Tags, storer storage.Storer, resolver resolver.Interface, pss pss.Interface, traversalService traversal.Service, feedFactory feeds.Factory, logger logging.Logger, tracer *tracing.Tracer, o Options) Service

New will create a and initialize a new API service.