Make a test call to an API with Swagger UI

In this topic, you learn how to make a test call to an API and see the response.

If you want to make test calls without sending data outside of your internal network, use the API Client to perform the test calls.

Prerequisites

  • You have created an API.

Procedure

  1. In the Cockpit, navigate to Connectivity and click Swagger UI.

    Result: The Swagger UI opens.

  2. From the API list on the left, select the API you want to make a test call to.

    Result: The Swagger UI pane shows the operations and models of the API.

  3. Click an operation to see its parameters and responses.

    You can still make test calls, even if you see No parameters.

  4. Click Try it out.

  5. Enter a value for each parameter of that operation.

  6. Click Execute.

    Result: The Swagger UI pane shows the curl, request URL, response body, and response header for your test call.

Results

  • You have made a test call to an API.

Related topics