@backstage/backend-app-api
Home > @backstage/backend-app-api
Core API used by Backstage backend apps.
Classes
| Class | Description |
|---|---|
| DefaultRootHttpRouter | The default implementation of the RootHttpRouterService interface for coreServices.rootHttpRouter. |
| HostDiscovery | HostDiscovery is a basic PluginEndpointDiscovery implementation that can handle plugins that are hosted in a single or multiple deployments. The deployment may be scaled horizontally, as long as the external URL is the same for all instances. However, internal URLs will always be resolved to the same host, so there won't be any balancing of internal traffic. |
| MiddlewareFactory | A utility to configure common middleware. |
| WinstonLogger | A LoggerService implementation based on winston. |
Functions
| Function | Description |
|---|---|
| createConfigSecretEnumerator(options) | |
| createHttpServer(listener, options, deps) | Creates a Node.js HTTP or HTTPS server instance. |
| createLifecycleMiddleware(options) | Creates a middleware that pauses requests until the service has started. |
| createSpecializedBackend(options) | |
| loadBackendConfig(options) | Load configuration for a Backend. This function should only be called once, during the initialization of the backend. |
| readCorsOptions(config) | Attempts to read a CORS options object from the backend configuration object. |
| readHelmetOptions(config) | Attempts to read Helmet options from the backend configuration object. |
| readHttpServerOptions(config) | Reads HttpServerOptions from a Config object. |
Interfaces
| Interface | Description |
|---|---|
| Backend | |
| CreateSpecializedBackendOptions | |
| DefaultRootHttpRouterOptions | Options for the DefaultRootHttpRouter class. |
| ExtendedHttpServer | An HTTP server extended with utility methods. |
| HttpRouterFactoryOptions | |
| LifecycleMiddlewareOptions | Options for createLifecycleMiddleware(). |
| MiddlewareFactoryErrorOptions | Options passed to the MiddlewareFactory.error() middleware. |
| MiddlewareFactoryOptions | Options used to create a MiddlewareFactory. |
| RootConfigFactoryOptions | |
| RootHttpRouterConfigureContext | |
| WinstonLoggerOptions |
Variables
| Variable | Description |
|---|---|
| authServiceFactory | |
| cacheServiceFactory | |
| databaseServiceFactory | |
| discoveryServiceFactory | |
| httpAuthServiceFactory | |
| httpRouterServiceFactory | |
| identityServiceFactory | |
| lifecycleServiceFactory | Allows plugins to register shutdown hooks that are run when the process is about to exit. |
| loggerServiceFactory | |
| permissionsServiceFactory | |
| rootConfigServiceFactory | |
| rootHttpRouterServiceFactory | |
| rootLifecycleServiceFactory | Allows plugins to register shutdown hooks that are run when the process is about to exit. |
| rootLoggerServiceFactory | |
| schedulerServiceFactory | |
| tokenManagerServiceFactory | |
| urlReaderServiceFactory | |
| userInfoServiceFactory |
Type Aliases
| Type Alias | Description |
|---|---|
| HttpServerCertificateOptions | Options for configuring HTTPS for an HTTP server. |
| HttpServerOptions | Options for starting up an HTTP server. |
| IdentityFactoryOptions | An identity client options object which allows extra configurations |
| RootHttpRouterFactoryOptions |