Swagger Studio API Integration
We currently support the OpenAPI 3.0 version.
This topic describes how to navigate and control the Swagger Studio API integration.
View Swagger Studio the APIs List in Swagger Explore
The Swagger Studio API integration on the left toolbar of Swagger Explore allows you to view and interact with all Swagger Studio APIs that you have access to.
By default, the last Swagger Studio updated APIs are displayed in descending order.
Search for Swagger Studio APIs in Swagger 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 Swagger Explore integration allows you to view Swagger Studio APIs directly in Swagger Explore but does not support bi-directional updates to Swagger Studio API.
Search for Swagger Studio APIs in Swagger Explore
To search for a Swagger Studio API in Swagger Explore , click the Swagger Studio icon on the left toolbar of Swagger Explore. Use the search bar at the top of the Swagger Studio 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 Swagger Studio 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 Swagger Studio APIs by specification, visibility, published state, or owner
You can use the filters to the right of the search bar to refine your Swagger Studio 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 Swagger Studio APIs
From the Swagger Studio API icon on the left-hand side panel, you can:
View Swagger Studio API Information.
Open the API definition in Swagger Studio.
View all connections associated with an API version.
To view Swagger Studio API information, select an API from the list and go to SwaggerHub API Information Information tab. 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 Swagger Studio 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 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 Swagger Explore
To export the OpenAPI definition, navigate to the Swagger Studio 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 Swagger Studio.
Fill out details for adding the API definition to Swagger Studio API, including name, version, and visibility.
Click Confirm.
Your API is now created inSwagger Studio. Follow the link to view it there.