Skip to content

Running the Crawler

To initiate a crawl, press the green Run Crawler button. This button is statically placed at the bottom of the plugin's user interface; it will be shown regardless of which tab is selected, even while not under the Crawler tab.

Run Crawler button, as seen in the user interface

Permission dialog

Clicking on the Run Crawler button may trigger a permission dialog to appear. When this happens, click on the Allow button to proceed with the operation.

Data overwrite

Triggering a new crawl may override data from the previous crawl. An overwrite happens when two models have the same identifier.

Scope Selection Dialog

Choosing which models to crawl

After clicking the Run Crawler button, a dialog will appear prompting you to set the scope of the crawl. There will be five options in the dropdown.

  • Select All to crawl all types of models.
  • Select Operations if you want to crawl operation metadata only.
  • Select Parameters if you want to crawl parameters only.
  • Select Responses if you want to crawl responses only.
  • Select Request Bodies if you want to crawl request bodies only.

Existing data for operations are required if you're not choosing the option All.

Where can I check for existing operations?

Use the OpenAPI tab to review data1 that's to be used for the OpenAPI schema.

Progress Dialog

Upon choosing the scope of the crawl, the plugin will begin the actual crawling procedure. While in progress, a progress dialog will be visible to show the status of the procedure.

Progress dialog

You will know the process is finished once the Progress dialog disappears.

Status Dialog

After a crawl, the Status dialog will appear. This dialog shows the logs sent by the plugin during the crawl, and allows you to debug the extracted data using JavaScript.

Status dialog

  • (1) Close button

    For closing the Status dialog.

  • (2) Log messages

    The collection of messages logged during the crawl is displayed in a list, each message having its own entry. You can copy the content of a message by clicking on its corresponding Copy to Clipboard button.

  • (3) Log filter

    Use this dropdown to filter log messages by level. There are five options available:

    • Show All - for showing all types of messages
    • Errors - for showing red messages
    • Infos - for showing light blue messages
    • Warnings - for showing orange messages
    • Primary - for showing blue messages; that is, messages that came from the evaluator
  • (4) Clear button

    For clearing the list of log messages.

  • (5) Evaluate editor

    A text area where you can supply Javascript code for debugging the output of the crawl. A return value is expected.

  • (6) Execute button

    Click this button, or press , in order to execute the code in the Evaluate editor.

  1. Either crawled or manually entered.