API Modelling – Handy Tools

When working in the API Modelling editor, JOSF provides several tools that make it easier to inspect, format and extract data from your API responses. These tools are available after executing an API request within the modelling editor.

The response body shows the content returned by the API and is also the data source used by your test actions and validations. JOSF includes multiple features to help you navigate and use this response data efficiently.

Generate xPath & JSONPath

AAfter executing an API request, the body tab will display the returned data. Often, when creating validations or building test steps, you will need to extract specific data nodes.
To make this process easier, JOSF can automatically generate the corresponding XPath (for XML) or JSONPath (for JSON) expressions.

To generate a path:

1. Right-click on the node or object you want to retrieve.
2. Choose Generate JSONPath or Generate XPath, depending on the response format.
   
   JOSF will return a list of possible paths that can be reused directly in your test actions, such as locators or object definitions. This reduces the need for manual path creation and ensures that your validations point to the correct elements in the response.

Search with JsonPath:

Sometimes it is necessary to confirm whether a path or node in your response points to the correct data. The Search with JSONPath feature allows you to temporarily filter the displayed response content.

Enter a JSONPath expression in the search bar to filter the data shown in the body viewer. This helps visually verify that the selected path returns the expected objects or values.

This action does not alter the response data or affect the actual test configuration, it only applies a temporary visual filter for validation purposes.

Beautify:

If your API response is displayed as a single line of text or is otherwise difficult to read, you can use the Beautifyoption to reformat it.

You can find the Beautify option in two ways:

• In the top-right corner next to the search with JsonPath.
• By right-clicking on the response body then beautify in the context menu.

Beautify reformats the response into a readable, indented structure. This makes it easier to inspect and locate specific data within the response. Like the JSONPath filter, Beautify is a visual aid only and does not modify the actual response data or the request configuration.