paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 40 Packages Projects Releases Wiki Activity

Add custom API entity page to create-app

Browse Source
This commit is contained in:
Oliver Sand
2020-12-07 15:21:32 +01:00
parent cb5fc4b29a
commit 221156b2f5
3 changed files with 76 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/seven-tips-begin.md
+10 -3
View File
@@ -1,6 +1,13 @@
---
'@backstage/create-app': patch
'@backstage/plugin-api-docs': patch
'@backstage/plugin-api-docs': minor
---
Add tables with consumes and provides relationships to the API and component entity pages.
Stop exposing a custom router from the `api-docs` plugin. Instead, use the
widgets exported by the plugin to compose your custom entity pages.
Instead of displaying the API definitions directly in the API tab of the
component, it now contains tables linking to the API entities. This also adds
new widgets to display relationships (bot provides & consumes relationships)
between components and APIs.
See the changelog of `create-app` for a migration guide.
.changeset/seven-tips-more.md
+5 -2
View File
@@ -6,10 +6,13 @@ Adjust template to the latest changes in the `api-docs` plugin.
## Template Changes
While updating to the latest `api-docs` plugin, the following changes are necessary for the `create-app` template in your `app/src/components/catalog/EntityPage.tsx`. This adds:
While updating to the latest `api-docs` plugin, the following changes are
necessary for the `create-app` template in your
`app/src/components/catalog/EntityPage.tsx`. This adds:
- A custom entity page for API entities
- Changes the API tab to include the new `ConsumedApisCard` and `ProvidedApisCard` that link to the API entity.
- Changes the API tab to include the new `ConsumedApisCard` and
`ProvidedApisCard` that link to the API entity.
```diff
import {