Crawler Toolbar

The Crawler toolbar is shown under the Crawler tab, just below the Crawler tab's label. The toolbar contains menu items for performing actions related to the current Crawler configuration. It is comprised of seven menu items, annotated and described below:

(1) Save

This menu item is shown as a floppy disk in the user interface and triggers a manual local save of your current Crawler configuration. A local save allows your configuration to be reloaded when you relaunch the Docs to OpenAPI plugin (after exiting).

Auto-save to the rescue!

Because the plugin now features auto-save, you don't really have to worry about your configuration being accidentally discarded. Docs to OpenAPI automatically initiates a save every time you type! While it may seem redundant at this point, the manual save button has remained to assure users that their configurations are up-to-date and locally saved.

I saved my configuration but it doesn't show when I relaunch the plugin

Docs to OpenAPI "remembers" the page opened and in focus while you were creating your Crawler configuration. It associates configurations with their respective documentation page URLs. This enables you to have multiple configurations, albeit each belonging to a different API, with the plugin still capable of knowing which configuration is for which API.

It is important to ensure that your API's documentation page is opened and selected (from the list of tabs) when reloading your saved configuration for that API.

(2) Open status dialog

This menu item opens the Logs dialog. The Logs dialog shows the list of log messages produced whilst crawling the web page.

But it's empty!

If you haven't run the Crawler yet, the dialog won't be able to show log messages.

(3) Clear data

This menu item is displayed with a trash bin icon and is used to reset the fields of your current Crawler configuration in addition to removing its saved local copy, if any.

(4) Copy OpenAPI specification to clipboard

Clicking on this menu item triggers the plugin to copy the generated OpenAPI schema JSON string to the clipboard.

(5) Export

Click this menu item to export the current Crawler configuration and/or generated OpenAPI schema.

(6) Import

Click this menu item to import a different Crawler configuration.

(7) Toggle strategy and scripts

Click this menu item to show the Strategy and Scripts tabs. These tabs will be shown at the bottom of each of the Operation, Request Body, Parameter, and Response tabs. The use of these tabs will come in play when creating a custom crawling strategy.