Data Runner - Yaak Plugin

I'm exploring Yaak plugin API to create a custom plugin.

The goal is to allow users to select a CSV or JSON file and iterate through the rows, running the same requests multiple times with different data each time.

Why is this needed?

This functionality is necessary to validate a dataset without manually creating multiple requests.

How to access Data Runner?

1. Right-click context menu

2. New tab in the request template (next to Info)

3. Create a new Data Runner template function to map to columns in the CSV

Workflow

1. Navigate to the Data Runner tab.

2. Select a CSV or JSON file.

3. The Data Runner function now operates based on column or property names.

4. Provides Preview and Run Request options.

5. On Preview, display a preview of all data in a modal dialog.

6. Upon Run Request, execute all requests in parallel.

7. Show the status of each request in a list view.

8. Selecting a request displays its output in the right pane.

9. Template functions in other requests should refer to the selected request's response payload.

The scope of this feature can be expanded from a single request to an entire folder or even a workspace.

Currently, there are several limitations within the Plugin API.

There's no way to extend the existing request UI in Yaak.

We will revisit this when the Plugin API is more mature, or maybe consider incorporating it directly into the core functionality.