Backstage
Docs
Github
Preparing search index...
@backstage/plugin-api-docs
index
Module index
A Backstage plugin that helps represent API entities in the frontend
Interfaces
ApiDocsConfig
Type Aliases
ApiDefinitionWidget
AsyncApiDefinitionWidgetProps
AsyncApiResolver
DefaultApiExplorerPageProps
GraphQlDefinitionWidgetProps
OpenApiDefinitionWidgetProps
PlainApiDefinitionWidgetProps
TrpcApiDefinitionWidgetProps
Variables
apiDocsConfigRef
apiDocsPlugin
ApiExplorerPage
EntityApiDefinitionCard
EntityConsumedApisCard
EntityConsumingComponentsCard
EntityHasApisCard
EntityProvidedApisCard
EntityProvidingComponentsCard
Functions
ApiDefinitionCard
ApiDefinitionDialog
ApiExplorerIndexPage
ApiTypeTitle
AsyncApiDefinitionWidget
ConsumedApisCard
ConsumingComponentsCard
DefaultApiExplorerPage
defaultDefinitionWidgets
GraphQlDefinitionWidget
HasApisCard
OpenApiDefinitionWidget
PlainApiDefinitionWidget
ProvidedApisCard
ProvidingComponentsCard
TrpcApiDefinitionWidget
References
plugin
→
apiDocsPlugin
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Interfaces
Api
Docs
Config
Type Aliases
Api
Definition
Widget
Async
Api
Definition
Widget
Props
Async
Api
Resolver
Default
Api
Explorer
Page
Props
Graph
Ql
Definition
Widget
Props
Open
Api
Definition
Widget
Props
Plain
Api
Definition
Widget
Props
Trpc
Api
Definition
Widget
Props
Variables
api
Docs
Config
Ref
api
Docs
Plugin
Api
Explorer
Page
Entity
Api
Definition
Card
Entity
Consumed
Apis
Card
Entity
Consuming
Components
Card
Entity
Has
Apis
Card
Entity
Provided
Apis
Card
Entity
Providing
Components
Card
Functions
Api
Definition
Card
Api
Definition
Dialog
Api
Explorer
Index
Page
Api
Type
Title
Async
Api
Definition
Widget
Consumed
Apis
Card
Consuming
Components
Card
Default
Api
Explorer
Page
default
Definition
Widgets
Graph
Ql
Definition
Widget
Has
Apis
Card
Open
Api
Definition
Widget
Plain
Api
Definition
Widget
Provided
Apis
Card
Providing
Components
Card
Trpc
Api
Definition
Widget
References
plugin
Docs
Github
Backstage
Loading...
A Backstage plugin that helps represent API entities in the frontend