catalog-backend-module-backstage-openapi

Summary

This module installs an entity provider that exports a single entity, your Backstage instance documentation, which merges as many backend plugins as you have defined in the config value catalog.providers.backstageOpenapi.plugins.

Notes

• This only works with the new backend system.

Installation

To your new backend file, add:

backend.add(
  import('@backstage/plugin-catalog-backend-module-backstage-openapi'),
);
Copy

Add a list of plugins and optional entity overrides to your config. For example:

catalog:
  providers:
    backstageOpenapi:
      plugins:
        - catalog
        - events
        - search
      definitionFormat: 'yaml"' # Optional, defaults to 'json'
      entityOverrides: # All optional
        metadata:
          name: 'my-name'
          title: 'my title'
        spec:
          owner: 'my-team'
Copy

We will attempt to load each plugin's OpenAPI spec hosted at ${pluginRoute}/openapi.json. These are automatically added if you are using @backstage/backend-openapi-utils's createValidatedOpenApiRouter.