API Hub for Design API Integration
We currently support the OpenAPI 3.0 version.
This topic describes how to navigate and control the API Hub for Design API integration.
View API Hub for Design APIs List in API Hub for Explore
The API Hub for Design API integration on the left toolbar of API Hub for Explore allows you to view and interact with all API Hub for Design APIs that you have access to.
By default, the last API Hub for Designupdated APIs are displayed in descending order.
Search for API Hub for Design APIs in Explore.
Enable the My Hub toggle to limit the search to APIs associated with you.
Filter APIs by specification, visibility, published state, or owner.
Open details for specific APIs.
Note
The API Hub for Explore integration allows you to view API Hub for Design APIs directly in Explore but does not support bi-directional updates to API Hub for Design API.
Search for API Hub for Design APIs in Explore
To search for a API Hub for Design API in Explore, click the API Hub for Design icon on the left toolbar of Explore. Use the search bar at the top of the API Hub for Design APIs list to search and discover public or private APIs.
View your APIs with the My Hub toggle
Select the My Hub switch to the right of the search bar to toggle between API Hub for Design APIs:
Toggle the switch to on, to limit the APIs to those you are an owner, collaborator, or a member of the owning organization.
Toggle the switch to off, to view and search across all public and private APIs you are associated with.
Sort and filter API Hub for Design APIs by specification, visibility, published state, or owner
You can use the filters to the right of the search bar to refine your API Hub for Design API search results:
Specification. Click the
and filter by OpenAPI specification. Visibility. Click the
and filter by public or private API status.State. Click the
and filter by published or unpublished API status.Owner. Click the
to filter by owner.
Work with the API Hub for Design APIs
From the API Hub for Design API icon on the left-hand side panel, you can:
View API Hub for Design API Information.
Open the API definition in API Hub for Design.
View all connections associated with an API version.
To view API Hub for Design API information, select an API from the list. It displays the following details of the APIs definition:
Visibility
State
Owner
View all available connections
Click the API you want to explore in the API Hub for Design API list to open the API connections panel.
Select any connection in the sidebar to:
Add input
Send requests
Receive responses
Add to Spaces
Generate OpenAPI Definition
Set up Request
To generate an OpenAPI definition, navigate to the Explore tab on the left-hand side panel.
Use the filters to the left to select the following from the dropdown lists:
Protocol (REST, Kafka)
Operation (GET, POST, PUT, DELETE, PATH, OPTIONS)
After creating a definition, save it to Spaces by clicking Add to Space.
Note
You can also add the connections to space for selected history records. For more information, see Access History Logs .
Export to Explore
To export the OpenAPI definition, navigate to the API Hub for Design tab on the left-hand side panel and do the following:
Navigate to the Spaces tab in the left toolbar.
Select your Space, and within that, select the API you wish to export.
Click Export to API Hub for Design.
Fill out details for adding the API definition to API Hub for Design API, including name, version, and visibility.
Click Confirm.
Your API is now created inAPI Hub for Design. Follow the link to view it there.