Backstage
    Preparing search index...

    Function createApiRef

    • Creates a reference to an API. The provided id is a stable identifier for the API implementation.

      Type Parameters

      • T

      Parameters

      • config: ApiRefConfig

        The descriptor of the API to reference.

      Returns ApiRef<T>

      An API reference.

      The frontend system infers the owning plugin for an API from the id. The recommended pattern is plugin.<plugin-id>.* (for example, plugin.catalog.entity-presentation). This ensures that other plugins can't mistakenly override your API implementation.

    Settings

    Member Visibility