Skip to main content
Swagger
All documentation pages

Link API Step from Studio

When you create a test step using Swagger Studio API definition, Swagger Functional Testing links the step to the source API operation. The link state is shown as a badge on the step. To learn more on how to add test steps from Studio API definition, check How to Create Tests.

From API definition means the step is actively connected. You can edit query parameters, headers, and the request body freely, but changing the method or path triggers a warning and removes the connection on save.

SFT_Screenshot_fromapi.png

Point to the badge to see the source API definition and open it in Swagger Studio.

SFT_Screenshot_link_popover.png

Disconnected means the step was previously linked but the connection was removed. The method and path can be edited freely.

SFT_Screenshot_fromapi2.png

Editing a Connected Step

You can edit query parameters, headers, and the request body without affecting the connection.

Changing the method or path disconnects this step from its API definition on save.

Select Revert to original value to restore the original method and path without saving. If you save with changes, the connection is removed and the badge changes to Disconnected.

Removing a Connection

  1. Select the From API definition badge.

  2. Select Remove connection.

Was this page helpful?