@backstage/backend-plugin-api
Home > @backstage/backend-plugin-api
Core API used by Backstage backend plugins.
Functions
| Function | Description |
|---|---|
| createBackendModule(config) | Creates a new backend module for a given plugin. |
| createBackendPlugin(config) | Creates a new backend plugin. |
| createExtensionPoint(config) | Creates a new backend extension point. |
| createServiceFactory(config) | Creates a root scoped service factory without options. |
| createServiceFactory(config) | Creates a root scoped service factory with optional options. |
| createServiceFactory(config) | Creates a plugin scoped service factory without options. |
| createServiceFactory(config) | Creates a plugin scoped service factory with optional options. |
| createServiceRef(config) | Creates a new service definition. This overload is used to create plugin scoped services. |
| createServiceRef(config) | Creates a new service definition. This overload is used to create root scoped services. |
Interfaces
| Interface | Description |
|---|---|
| BackendFeature | |
| BackendModuleConfig | The configuration options passed to createBackendModule(). |
| BackendModuleRegistrationPoints | The callbacks passed to the register method of a backend module. |
| BackendPluginConfig | The configuration options passed to createBackendPlugin(). |
| BackendPluginRegistrationPoints | The callbacks passed to the register method of a backend plugin. |
| CacheService | A pre-configured, storage agnostic cache service suitable for use by Backstage plugins. |
| DatabaseService | The DatabaseService manages access to databases that Plugins get. |
| DiscoveryService | The DiscoveryService is used to provide a mechanism for backend plugins to discover the endpoints for itself or other backend plugins. The purpose of the discovery API is to allow for many different deployment setups and routing methods through a central configuration, instead of letting each individual plugin manage that configuration. Implementations of the discovery API can be as simple as a URL pattern using the pluginId, but could also have overrides for individual plugins, or query a separate discovery service. |
| ExtensionPointConfig | The configuration options passed to createExtensionPoint(). |
| HttpRouterService | |
| IdentityService | |
| LifecycleService | |
| LifecycleServiceShutdownOptions | |
| LifecycleServiceStartupOptions | |
| LoggerService | A service that provides a logging facility. |
| PermissionsService | |
| PluginMetadataService | |
| PluginServiceFactoryConfig | |
| RootConfigService | |
| RootHttpRouterService | |
| RootLifecycleService | |
| RootLoggerService | |
| RootServiceFactoryConfig | |
| SchedulerService | |
| ServiceFactory | |
| ServiceRefConfig | |
| TokenManagerService | Interface for creating and validating tokens. |
| UrlReaderService | A generic interface for fetching plain data from URLs. |
Namespaces
| Namespace | Description |
|---|---|
| coreServices | All core services references |
Type Aliases
| Type Alias | Description |
|---|---|
| CacheServiceOptions | Options passed to CacheService.withOptions(). |
| CacheServiceSetOptions | Options passed to CacheService.set(). |
| ExtensionPoint | TODO |
| LifecycleServiceShutdownHook | |
| LifecycleServiceStartupHook | |
| ReadTreeOptions | An options object for UrlReaderService.readTree() operations. |
| ReadTreeResponse | A response object for UrlReaderService.readTree() operations. |
| ReadTreeResponseDirOptions | Options that control execution. |
| ReadTreeResponseFile | Represents a single file in a UrlReaderService.readTree() response. |
| ReadUrlOptions | An options object for readUrl operations. |
| ReadUrlResponse | A response object for UrlReaderService.readUrl() operations. |
| SearchOptions | An options object for search operations. |
| SearchResponse | The output of a search operation. |
| SearchResponseFile | Represents a single file in a search response. |
| ServiceFactoryOrFunction | Represents either a ServiceFactory or a function that returns one. |
| ServiceRef | TODO |