How to Write Tests

1. To start working with API Hub for Test, click on the Test tile on the API Hub main page.

API_Hub_For_Test_Screenshot_landingPage.png

2. Test Steps screen appears. Click on the plus icon to reveal the options available.

API_HUB_Test_Screenshot_Add_Step.png

3. After you choose your Test Step type, fill in the details.

API_Hub_For_Test_Screenshot_APIcall1.png
API_Hub_For_Test_Screenshot_APIcall2.png

You can dynamically select values in an API response and assign them to a variable to use in another API request.

API_Hub_For_Test_Screenshot_APIcall3Values.png

Go to Define an API request to learn more.

Tip

You can reorder test steps by dragging and dropping them. Move single or multiple steps up or down, even in and out of segments.

You can also duplicate selected steps in test cases. Duplicated steps appear right after the last selected step. If the last selected step is inside a segment, the steps are duplicated after the segment. Segments cannot be duplicated.

Once you complete all of the test steps, you can run a test for your test case.

API_Hub_For_Test_Screenshot_RunTestCase.png

Click View Results to find more details connected to your test run.

API_Hub_For_Test_Screenshot_RunTestCaseViewResult.png
API_Hub_For_Test_Screenshot_TestCaseRunResult.png

4. Go to the Test tab, to see the list of all your Test Cases.

API_Hub_For_Test_Screenshot_TestCases.png

How to Add Test Steps from Endpoints Created in API Hub for Design

  1. Click the + icon to add an API in your Test Definition view.

    API_HUB_Test_Screenshot_Create_ApiStep1.png

  2. Select Create APIs step from OpenAPI spec.

  3. Choose the APIs and endpoints from the modal and click theAdd Test Steps button to proceed. You can choose the version of your endpoints.

    API_HUB_Test_Screenshot_APIChooseVersion.png

  4. Selected endpoints are added as test steps to your test.

    API_HUB_Test_Screenshot_APIBaseURL1.png

  5. If you add the step from API Hub for Design, a new parameter called baseURL is created and inserted before each endpoint path. You can update baseURL and add other variables and parameters from the test definition page above.

  6. Click Execute Request to verify the response.

  7. Enter a value and save the whole test by clicking the Save button.

How to Create Test From API Hub for Explore

  1. If you decide to create a test from the entire set of API endpoints, navigate to Explore and click on Create Test Case.

    API_HUB_Test_Screenshot_Create_Test_Case1.png

  2. Select the endpoints you want to add to your test. You can choose an existing test case from the drop-down menu.

    API_HUB_Test_Screenshot_Create_Test_Case2.png

  3. Click the Add Steps button to proceed.

  4. Test case is created. Click Save.

  5. You can now run your test case or create more test steps.

In this section:
© 2025
Publication date: