To use Swagger UI for testing your APIs, navigate to the API List View and select the relevant API from the list. From there, click the API Specification UI button to access Swagger UI. This web-based interface is widely recognized as the standard tool for API testing and provides an intuitive way to test APIs.

Note that in order for the button to be enabled, there must be an active Trigger.

Frends uses the standard Swagger UI, which you can test via their online demo if you're interested.

The exact content displayed in Swagger UI will depend on your API. The main purpose of Swagger UI is to display all API endpoints, the data that they consume, and the returns. It also allows you to run calls to those endpoints. The calls are actually made and will start the corresponding Frends Processes as normal.

If an API key is required but hasn't been set up in the authorization header, a window will appear before accessing Swagger UI.

You can execute calls to your API endpoints using the "Try it out" button. Clicking this button lets you edit the request payload, if necessary. Beneath it, you can view the responses that the API might return according to its specification.

When everything looks correct, you can hit the "Execute" button. After execution, Swagger UI will send a request from your computer and display the result, along with a curl command that shows what was actually sent.

The next article is Introduction to OpenAPI Specification