search

event-catalog / eventcatalog

An open source documentation tool to bring discoverability to your event-driven architectures
https://eventcatalog.dev
MIT License
1.67k stars 139 forks source link

Backstage #731

Open hvandenb opened 3 weeks ago

hvandenb commented 3 weeks ago

Feature Request

Backstage is a popular developer portal. It support catalogs and markdown documention. Ideally Event Catalog is integrated with it.

Some suggested options

  1. Plugin to allow content from EC to be shown
  2. Integrate the software catalog (services etc) into EV
boyney123 commented 2 weeks ago

Will be exploring this in September, any suggestions are welcome. I'm new to backstage, so any thoughts would be welcome if anyone has any.

hpatoio commented 3 days ago

Ciao, a couple of notes that I hope can speedup your on boarding on Backstage.

Backstage's catalog is a collection of entities. An entity can be of kind component. Quoting Backstage's doc a Component describes a software component. See here the details.

I think that you can map a component to an EV'service

Components can provide or consume APIs

Also api is a kind of entity. (details here) API can be of differents types. I think you are interested only in openapi and asyncapi.

Specs can be put inline as in the example of you can reference a file. Both in the same repo 

  definition:
    $text: my-openapi.yml

or external as URL. 

  definition:
    $text: https://my.source/asyncapi.com

To group components you can use systems and domains https://backstage.io/docs/features/software-catalog/system-model/#ecosystem-modeling

Hope it helps to put your head on Backstage