Skip to main content
Version: v2.17.x LTS

Using Swagger "Try it out" in the API Catalog

Using Swagger "Try it out" in the API Catalog

The API Catalog makes it possible for users to call service APIs through the Try it out functionality. There are 2 types of endpoints:

  • Public endpoints

    Endpoints that are accessible without entering user credentials.

  • Protected endpoints

    Endpoints that are only accessible by entering user credentials. These endpoints are marked with a lock icon.

    Example:

    endpoint detail

    Before making requests to protected endpoints, authorize your session by clicking the lock icon and complete the required information in the Authorization modal:

    Example:

    endpoint detail

To demonstrate Try it out, we use the example of the Swagger Petstore.

Example:

endpoint detail

Make a request

Follow this procedure to make a request.

  1. Expand the POST Pet endpoint.

  2. Click Try it out.

    Example:

    endpoint detail

    After you click Try it out, the example value in the Request Body field becomes editable.

  3. In the Example Value field, change the first id value to a random value. Change the second name value to a value of your choice, such as the name of a pet.

  4. Click Execute.

    Example:

    endpoint detail

    The API Catalog Swagger UI submits the request and shows the curl that was submitted. The Responses section shows the response.

    Example:

    endpoint detail

On this page