Using AutoTest Assist

AutoTest Assist, which is provided by IBM API Connect Test and Monitor, performs quality testing of an API by sending it a series of randomly-generated requests. These requests are informed by the API definition and any custom rules that you define. You receive alerts for any conformance errors or server-side errors that AutoTest Assist observes in the course of testing.

Prerequisites

  • You have the following components:

    • An OpenAPI document that defines the interface of the target API. In the current release of IBM Cloud Pak® for Integration, this document must conform to OpenAPI 2.0 (Swagger 2.0).

    • A URL that points to a test deployment of the API.
      Important: The auto-tester may send thousands of requests to this endpoint, depending on how you configure the AutoTest profile.

    • Credentials for the deployment. In this release of Cloud Pak for Integration, credentials consist of a username and password, or an API key.

Important: When using AutoTest Assist, do not use a parameter location of type formdata in an OpenAPI 2.0 specification. Doing so will result in an error. Allowed locations are query, header, path, and cookie.

Enabling AutoTest Assist on an API Connect cluster

  1. Log in to the Platform UI.

  2. Find API Connect cluster in the list of instances that you want to modify and click the overflow menu (three-dot icon) in that row. Click Edit.

  3. Set Advanced settings to on, then click Management subsystem. The form automatically scrolls to the Management subsystem section.

  4. Scroll to the Test and Monitor subsection.

  5. Set Advanced: Enable Test and Monitor (optional) to on.

  6. Set Advanced: Enable AutoTest Assist (optional) to on.

  7. Click Update.

Next, follow the steps in "Creating an AutoTest Assist profile".

Creating an AutoTest Assist profile

Create and execute an AutoTest profile to support your API integrations.

  1. Log in to the Platform UI.

  2. Find API Connect cluster in the list of instances that you want to modify, and click the instance name to open it.

  3. If you get a login page, click Cloud Pak User Registry or API Manager User Registry.

  4. Click the Test APIs tile.

  5. Create a new test suite, or open an existing test suite, and click the Tests tab.

  6. Follow the steps for Creating an AutoTest profile in the API Connect documentation.