Version: Next

FrontendHostDiscovery

Home > @backstage/core-app-api > FrontendHostDiscovery

FrontendHostDiscovery is a config driven DiscoveryApi implementation. It uses the app-config to determine the url for a plugin.

Signature:

class FrontendHostDiscovery implements DiscoveryApi 

Implements: DiscoveryApi

Methods

Method	Modifiers	Description
fromConfig(config, options)	`static`	Creates a new FrontendHostDiscovery discovery instance by reading the external target URL from the `discovery.endpoints` config section. eg. `discovery: endpoints: - target: https://internal.example.com/internal-catalog plugins: [catalog] - target: https://internal.example.com/secure/api/{{pluginId}} plugins: [auth, permissions] - target: internal: https://internal.example.com/search external: https://example.com/search plugins: [search]` If a plugin is not declared in the config, the discovery will fall back to using the baseUrl with the provided `pathPattern` appended. The default path pattern is `"/api/{{ pluginId }}"`.
getBaseUrl(pluginId)

Method

Modifiers

Description

fromConfig(config, options)

static

Creates a new FrontendHostDiscovery discovery instance by reading the external target URL from the discovery.endpoints config section.

eg.

discovery:
 endpoints:
   - target: https://internal.example.com/internal-catalog
     plugins: [catalog]
   - target: https://internal.example.com/secure/api/{{pluginId}}
     plugins: [auth, permissions]
   - target:
       internal: https://internal.example.com/search
       external: https://example.com/search
     plugins: [search]

If a plugin is not declared in the config, the discovery will fall back to using the baseUrl with the provided pathPattern appended. The default path pattern is "/api/{{ pluginId }}".

getBaseUrl(pluginId)

Methods​

Methods