Skip to main content

Debugger

The Debugger is a tool to help you develop and test your connector. It is based around a crawler which can autonomously browse your connector and discover paths, perform validations, and ensure compliance with the API specification.

Test account​

For most connectors, the Debugger will need to include a credentials header to be able to successfully make authenticated calls to your connector. The Debugger will use one of the test accounts provided in your configuration file (default is development unless otherwise specified using the --test-account command flag).

See the TestAccount Page for more information.

Interactive mode​

The interactive Debugger can be launched with the dev command.

integration-cli dev

Non-interactive mode​

The non-interactive Debugger can be launched with the test command.

integration-cli test

Crawl mode​

By default, the Debugger crawls your connector in full mode, which means that all the discovered paths are crawled and tested. You can change the crawl mode with the --crawlMode option.

integration-cli test --crawlMode=sample

Three options exist;

  • full — Crawls each path it finds.
  • sample — Crawls a subset of the discovered paths.
  • single — Crawls a single path.
warning

When using a non-full mode, only a subset of the paths are crawled. Therefore, it is possible that bugs in your connector are not detected by the Debugger. Prefer the full mode when possible.

At any time, you can press q to stop an active crawl.

Checks​

By default, the tool validates basic properties of the crawled paths. For example, if a Collection is crawled, the response must comply to the API specification. Additional validation is performed using checks, which can be enabled interactively or through the CLI.

integration-cli test --checks=SelectSemantics,CreateItem

The complete list of available checks can be found in the interactive Debugger mode.