Using Templates

Applies to ReadyAPI 3.57, last modified on December 20, 2024

ReadyAPI provides a quick way to configure your load test for a load testing scenario by using templates. Templates are based on popular load testing scenarios and provide basic settings fitting these scenarios. To create a load test based on the template:

  1. Right-click the project in ReadyAPI and select New LoadUI Test, or click in the toolbar.
    Alternatively, you can create a load test from the New Test tile which is available on the Dashboard. To do this, click Load Test on the tile.

  2. In the New Load Test dialog, select a template to be used. You can find more information about template parameters in the topic about the load testing scenario you intend to use. Click OK.

    API load testing with ReadyAPI: Creating a load test from Template: Start

    Click the image to enlarge it.

  3. The Create Load Test wizard will open. On the first step of the wizard, specify the test target.

    API load testing with ReadyAPI: Creating a load test from Template: Select Test Target

    The following targets are available:

    • Test case – select a functional test case and create a load test based on it.

    • Single request – select a request to the API. ReadyAPI will create a functional test case with a single test step and create a load test.

    • URL – enter your API URL. ReadyAPI will import it to the project, create a functional test case and a load test.

  4. On the same page of the wizard, specify the load test name. Click Next.

    API load testing with ReadyAPI: Creating a load test from Template: Set Test Name

    Click the image to enlarge it.

  5. On the second page of the wizard, specify the load simulated by the test. If you are not sure, use default values. Click Next.

    API load testing with ReadyAPI: Creating a load test from Template: Set Load

    Click the image to enlarge it.

  6. On the third page of the wizard, you can select a server to monitor. Make sure your server is ready for monitoring. If you are not sure what type of server your API is run on, select Skip this step to skip server monitor creation, and click Next.

    API load testing with ReadyAPI: Creating a load test from Template: Set Up Monitors

    Click the image to enlarge it.

    Otherwise, specify the following values:

    • Server name – The name of the server in ReadyAPI.

    • Target server – The host name or IP address of the server you intend to monitor. For example, you can specify both localhost and 127.0.0.1 to monitor a local computer.

    • Monitor name – The name of the monitor in ReadyAPI.

    • Monitor type – Select one of the available monitor types. Depending on the type you selected, you may need to specify additional parameters.

  7. On the fourth step of the wizard, configure the test assertions. Test assertions monitor the test execution and trigger when the monitored metrics go above the specified value. If you are not sure what each assertion monitors, see the statistics reference. Click Finish to create a load test.

    API load testing with ReadyAPI: Creating a load test from Template: Set Up Assertions

    Click the image to enlarge it.

ReadyAPI will create a load test based on the selected template.

See Also

1. Create a New Load Test
Manually
About ReadyAPI Dashboard

Highlight search results