IBM API Studio

The IBM API Studio tool simplifies deployment, accelerates test creation, and enables quick testing to automate and manage the API lifecycle efficiently.

The IBM API Studio toolset streamlines key tasks, including the following actions:

Publishing of APIs to a catalog in API Connect
Creation of test configurations based on an API
Running of these generated tests

Key highlights

StudioPublishProjectAPI

Simplifies the deployment of API projects by allowing developers to publish directly to specified catalogs, gateways, and spaces. This action ensures consistent visibility and management of APIs in API Manager.
StudioCreateTest

Accelerates test creation by auto-generating YAML-based test and assertion files for an API. This helps maintain test coverage and reduces manual effort in setting up validation logic.
StudioRunTest

Enables quick running of API tests by specifying the test namespace, name, and version. Results are displayed directly in the IBM API Studio, which supports rapid feedback and debugging.

Together, these tools enhance productivity, reduce manual configuration, and promote a more automated and reliable API lifecycle.

StudioPublishProjectAPI

Publish projects in IBM API Studio with API Agent where you can optionally specify a catalog, gateway, and a space. After the project is published, you can see its status on the Manage page in API Manager.

Table 1. Parameters
Parameter	Required	Default	Description
`project_name`	Yes	None	The name of the project is to be published.
`catalog`	No	Sandbox	The name of the catalog to publish the project.
`gateway`	No	None	List of the gateways to publish the project.
`space`	No	None	The name of the space to publish the project.

Example prompts

```
Publish project Dogs
```

Publish project Dogs to catalog Petstore

Publish project Dogs using gateways pets-service and webmethods-animals-service to catalog Petstore

Publish project Dogs using gateway pets-service to catalog Petstore and in the Vets space

StudioCreateTest

Generate test cases for an API in IBM API Studio. Specify the API name, and the tool creates the corresponding YAML documents for both the validation and its associated assertions. These files are added directly to your current project or, if you are not currently in a project, you are prompted to select one first.

Table 2. Parameters
Parameter	Required	Description
`api`	Yes	The name of the API to generate test cases for.

Example prompts

Create a test for the project Project API Orders

```
Generate a test for the API WeatherAPI
```

StudioRunTest

Run a test file for an API in IBM API Studio with API Agent. Specify the test namespace, name, and version so that API Agent understands which test to run and displays the results.

Table 3. Parameters
Parameter	Required	Description
`test_namespace`	Yes	The namespace of the test to run.
`test_name`	Yes	The name of the test to run.
`test_version`	Yes	The version of the test to run.

Example prompts

```
Run the WeatherAPITest version 1.3.14 in the namespace WeatherStationProject.
```
Note: You can also specify the test to run by using a test reference in the format namespace:name:version.

Run the test WeatherStationProject:WeatherAPITest:1.3.14