Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This new ToolsOnAir REST API provides almost all the features of the well-known Just Control user interface. The ToolsOnAir REST API can easily be tested with the Postman.app for macOS or with the integrated Swagger-UI..

Please note that the API calls are received by the Just In Engine application, therefore the REST API IP Address of the machine running the Just In Engine application must be used.

Swagger-UI

To access the integrated Swagger-UI, open a web browser and enter the following address: "IP-Address:8080/swagger-ui/index.html". You should then see the following:

...

Here the API can be easily tested. If you want to use Postman for testing, please follow the instructions below.

Import into Postman by using a URL

...

Afterward, the ToolsOnAir REST API can be tested with the Postman.app. Please note that the IP address might need to be adjusted.

...

Use http://editor.swagger.io

In case the Postman.app is not an option, http://editor.swagger.io can be used alternatively. Analogous to the Postman.app open the link - http://localhost:8080/v3/api-docs - on the machine where the Just In Engine application is running and copy the contents of that page. Then open http://editor.swagger.io in a browser of your choice and paste the ToolsOnAir REST API JSON content to the left side of this page. The ToolsOnAir REST API will appear on the right side of the page.

...