Swagger "Try it out" functionality in the API Catalog
The API Catalog enables users to call service APIs through the Try it out functionality. There are 2 types of endpoints:
Endpoints that are accessible without entering user credentials.
Endpoints that are only accessible by entering user credentials. These endpoints are marked with a lock icon.
Note: Before making requests to protected endpoints, authorize your session by clicking the lock icon and complete the required information in the Authorization modal shown below:
To demonstrate Try it out, we use the example of the Swagger Petstore.
Make a request
This section outlines the process for making a request.
Follow these steps:
Expand the POST Pet endpoint.
Click Try it out.
After you click Try it out, the example value in the Request Body field becomes editable.
In the Example Value field, change the first
idvalue to a random value. Change the second
namevalue to a value of your choice, such as the name of a pet.
The API Catalog Swagger UI submits the request and shows the curl that was submitted. The Responses section shows the response.