Testing the REST API on FlowWright

Learn to test the REST API on FlowWright

Last published at: July 30th, 2024

FlowWright's REST API has always been documented, but users could not test it unless they wrote code to make REST API calls. In our latest version, we made several upgrades to the REST API and supporting technologies to help our customers easily test the REST API calls, and we share them below.

First, FlowWright UI now shows the database connection used by the REST API.  You can view the database connection string with the rest of the database connection string under Status Database (as shown below in the dashboard).

 

REST API can also be easily accessed from the UI:

 

REST API documentation and the testing UI will render as follows:

 

Just select a class and select a method to view the documentation and test the method:

 

Click the "Try it out!" button to test the REST call, results from the call will be displayed below:

 

REST API requires authentication; you can use a username and password or, in the case of Active Directory-integrated users, the username and license key. Due to customer demand, this functionality was on our roadmap, and we delivered it in FlowWright; now, you can test API calls from the UI.

If you would like to test it out on our test site, click the icon below and log in as “admin.” After logging in, press the "Try it out" button.