Authoring tests from OpenAPI specification

In IBM API Studio, the Form view lets you auto-author tests using an intuitive interface that uses the API schema to guide input.

About this task

IBM API Studio automates test creation by allowing you to configure request details, headers, authentication, and expected responses without writing YAML. The structured layout helps you define and manage test parameters efficiently, making test authoring faster and more accessible.

Procedure

  1. Select an API project from the home page.
    The project opens in the Explorer.
  2. Click Add a test on the quick access page.
  3. On the Add test page, provide the test details.
    • Test name. Enter a name for the test.
    • Namespace. Specify the namespace for the test.
    • Version. Provide the version number of the test.
    • Tags. Add relevant tags for identification.
  4. Select Create from spec and click Create.
    IBM API Studio creates the test, assertions, and environments files in the tests folder within your current project folder. The test file is placed at the top level, while assertions and environments are organized into dedicated sub-folders. These files are linked to the test file to define validation rules and execution contexts.

What to do next

The test is configured and ready to run. For more information, see Running authored tests by using UI.