Consume API
Each topic in this section focuses on a different use case in the consumer view of Portal .
Read these sections if you are already familiar with the basics of Portal, and want to quickly learn the steps needed to complete a specific task.
Try out OpenAPI
To try out an OpenAPI:
-
Select an API endpoint to open its contents.
-
Select Try it out.
Learn more about options for routing API requests here.
Explore OpenAPI
You can test how your OpenAPI definitions behave with our Swagger Explore integration. Read more about integrations here.
Code Snippets
Users can generate code snippets when APIs are rendered using our Elements integration.
Code snippets are only available for OpenAPI definitions, not AsyncAPI definitions.
Generate Code OpenAPI
OpenAPI definitions also allow you to generate code with the following options:
-
Client SDK
-
Server Stub
-
Documentation
For more information, see Generating Code in the Swagger Studio documentation.
Download OpenAPI
To download an OpenAPI definition:
-
Select Generate Code.
-
In the drop-down menu, select Download API.
-
In the side menu, select one of the file formats:
-
JSON
-
YAML
-
Download AsyncAPI
To download an Async API:
-
Select the Download API drop-down menu.
-
Select one of the file formats:
-
JSON
-
YAML
-
The active AsyncAPI is downloaded.
Portal shows and downloads APIs in resolved state.