SOAtest can automatically create a .tst based on the endpoints found in a RAML description. Each .tst generated via the RAML wizard will contain REST Clients for all of the defined endpoints. 

RAML 0.8 and 1.0 are supported.
To automatically create a test suite from a valid RAML definition:

  1. Choose the REST> RAML option in one of the available test creation wizards. For details on accessing the wizards, see Adding a New .tst File to an Existing Project and Adding a New Test Suite.
  2. In the RAML wizard page, enter the absolute URI at which to find the RAML definition in the RAML Definition field. To reference a file on your local system, use a file URL (for example, file:///c:/Users/user/API.raml).
  3. Click Next. The Create Environment dialog opens.
  4. (Optional) Specify whether you want to reference an existing environment or create a new one.
    • To create a new environment:
      1. Select the Create a new environment for your project checkbox.
      2. Enter an Environment Name and Variable Prefix.
    • To reference an existing environment, select Reference an existing environment then specify the appropriate environment file.
    • For more information on environments, see Configuring Testing in Different Environments.
  5. Click the Finish button.

When a .tst is generated, it includes one REST Client for each resource/method pair in the RAML definition.

  • Each REST Client is set to be constrained to the specified service definition and schema (if applicable).
  • Its resource URL, HTTP method, and payload (if applicable) are configured accordingly.
  • The service's base URL is configured as a "BASEURL" variable, and each resource URL is parameterized with the "BASEURL" variable.
  • Query parameters are included with default or sample values (if available) as defined by the service definition.
  • If the service definition includes a schema (XML or JSON), a sample payload is constructed from (and constrained to) that schema.


  • No labels