Swagger UI
You can test APIs via Swagger UI.
Make test calls with the parameters defined for each operation of the API and see the responses of your test calls. You can perform test calls without implementing the API in an application first.
Test calls are based on operations that have been previously defined, in the API Designer. Optionally, you can test operation parameters that you have defined in the API Designer using the the API Client.
| If you want to make test calls without sending data outside of your internal network, use the API Client to perform the test calls. |
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. |
Procedure
-
In the Cockpit, navigate to Connectivity and click Swagger UI.
Result: The Swagger UI opens.
-
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.
-
Click an operation to see its parameters and responses.
You can still make test calls, even if you see No parameters. -
Click Try it out.
-
Enter a value for each parameter of that operation.
-
Click Execute.
Result: The Swagger UI pane shows the curl, request URL, response body, and response header for your test call.