Setting up a new synchronization source

You can set up a Swagger document in an IBM® API Developer Portal instance as a synchronization source in an HCL OneTest™ API project.

About this task

Before synchronizing with a Swagger document in an API Developer Portal instance, you must first create a physical HCL OneTest API connection to that API Developer Portal instance.

Procedure

  1. Open the Logical View of the Architecture School perspective of HCL OneTest API.
  2. Open the toolbar of Logical View, click Web > Swagger Definition. The Synchronization Source window in the Create a new Synchronization Source wizard is displayed. Look for Swagger Definition in the Type list.
  3. Click Registry next to the Location field. The Browse a Service Registry window is displayed.
  4. Verify that the Service Registry URL list displays the IBM API Developer Portal instance that you want to use.
  5. Optionally, you can perform any of the following tasks:

  1. Click Find REST APIs to search for the Swagger document that you want to import. Depending on the search parameters that you selected, search results are displayed in the Browse a Service Registry window.
  2. Double-click the relevant API service. The Swagger documents associated with the selected API service are displayed.
  3. Select the Swagger document that you want to import.

    Selecting the Swagger document

  4. Click OK to close the Browse a Service Registry window. The selected Swagger document is displayed in the Configuration area on the Synchronization Source window in the Create a new Synchronization Source window.

    Selected Swagger document

  5. Click Next. The Generate Assets for Operation window in the Create a new Synchronization Source wizard is displayed.
  6. To generate tests and virtual services for the operation, click Create Tests and Create Stubs. You can modify the name of the asset or continue to use the default name.

    Create tests and stubs for the selected Swagger document

  7. Click Next. The Create Test for Operation window of the Create a new Synchronization Source wizard is displayed.
  8. For each test you requested, provide the following information:
    Note: The number of tests to be created is shown in the Test creation progress bar at the bottom of the window.
    1. Select a source option for the Input message:
      Generate message from Schema
      Use the schema information from the source document to generate the Input message.
      Specify a message
      Create your own message. You can enter the message in the text box that is provided, paste it from your copy/paste buffer, or browse to a file that contains the message. The message can be in XML, JSON, or any other supported message format.
    2. Select Include optional schema fields to complete the message with optional fields from the schema that is provided by the source document.
    3. Select a source option for the Output message. The options that are available are the same as the ones for the Input message, with the exception that you can opt to not generate an Output message.
    4. Click Next and repeat this step for each of the generated tests.

      Creating a text by clicking Next.

    When you have specified sources for all tests, a Summary page is displayed.

    Summary page

    Click Finish. The Test Factory perspective is displayed.

Results

HCL OneTest API imports the selected Swagger document and adds it as a synchronization source to the logical model of your project.
Feedback