backstage-plugin-konfig

Konfig Plugin

:warning: This plugin is WIP. Today, this plugin will only lint your OpenAPI Specification using our linter specifically built for ensuring high quality SDK generation. If you are interested please reach out to [e-mail] or schedule a time with us here!

Welcome to the Konfig Backstage plugin!

This plugin allows you to generate SDKs for your APIs.

Setup

1. Install this plugin:

# From your Backstage root directory
yarn --cwd packages/app add backstage-plugin-konfig

Entity Pages

1. Add the plugin as a tab to your Entity pages:

// In packages/app/src/components/catalog/EntityPage.tsx
import { EntityApiDocsKonfigContent, isApiDocsKonfigAvailable } from 'backstage-plugin-konfig';

...

const apiPage = (
  <EntityLayout>
    {/* other tabs... */}
    <EntityLayout.Route if={isApiDocsKonfigAvailable} path="/konfig" title="Konfig">
      <EntityApiDocsKonfigContent />
    </EntityLayout.Route>
  </EntityLayout>