Update API Modules with API Scan

You generate API Modules when you export API messages from Tricentis Tosca API Scan to Tosca Commander. If these API messages change you have to change your API Modules accordingly, e.g. if the response that you should receive for a specific request changes.

To avoid creating new Modules from scratch every time your API messages change, you can use API Scan to update your existing API Modules. To do so, follow the steps below:

  1. Select the API Module that you want to update in Tosca Commander.

  2. In the API Testing menu, click the API Scan icon.

  3. Select Open selected Modules from the dropdown menu, to open the API Module in API Scan.

Open the selected Module in API Scan

  1. Modify your messages in API Scan as required. For instance, you can send a request again if the response has changed, or edit the message information.

    For more information on how to work with messages in API Scan, see chapter "Tricentis Tosca API Scan".

  2. To update the changes in the corresponding API Module in Tosca Commander, click the Update icon.

Change payload and click Update in API Scan

The system updates the API Module in Tosca Commander. You can see your changes in the Technical View tab.

Updated Module with changed payload in Tosca Commander

If you have created a Module Attribute for an updated message element, you also have to update the Module Attribute. For more information on how to do so, see the video guide below and chapter "Update Module Attributes".

Video - Update API Modules

Learn how to update API Modules and Module Attributes.

This video was created with Tosca version 12.1