Docs - typescript

Run the following command in your terminal to generate an integration test:

skyramp generate integration rest https://demoshop.skyramp.dev/api/v1/products \
--language typescript \
--framework playwright \
--api-schema

Upon completion, Skyramp creates a fully executable TypeScript test file (products_integration_test.spec.ts) that can be run immediately. The content of the generated test is explained here.

Explanation of Command

https://demoshop.skyramp.dev/api/v1/products: Defines the URL to the endpoint we aim to test.
--language: Specifies the test output language. We currently support Python, Java, and TypeScript.
--framework: Specify the test execution framework of choice.
--api-schema: Points to the OpenAPI schema used to generate the test. We also support sample data and traces as inputs for test generation.

Execute your Test

You can execute the generated tests without any additional adjustments to the code. However, based on the application you want to test, you can pass your authentication token to Skyramp Tests via an environment variable.

Set environment variable for authentication header

To test against an application that requires authentication, pass your token using our environment variable. By default, Skyramp expects a Bearer Token but we support additional authentication methods (Example 3). If your API does not require any authentication, you can skip this step and just run the test.

Skyramp’s sample application requires a session identifier. Quickly obtain your session_id via the Demo Shop UI and set it as your authentication header. Additional information and ways to obtain the session_id can be found here.

export SKYRAMP_TEST_TOKEN=$your_auth_token

Run the Test

Now you can run the tests using Playwright. If you don’t have Playwright, refer to the Installation Guide for setup instructions:

npx playwright test products_integration_test.spec.ts --reporter

Your integration test will perform the following sequence of actions:

Creation: Adds a new product to the Demo Shop.
Retrieval: Confirms the product has been successfully added.
Update: Modifies details of the created product.
Deletion: Deletes the created and modified product.

The test automatically identifies the relevant path parameters, intelligently chains the different requests together, and executes the test against the specified URL.

Review Test Results

By default, TypeScript’s List reporter provides clear and concise output indicating the success or failure of each step executed:

Each executed test will be displayed clearly in the terminal.
All encountered errors or issues will be summarized for easy debugging at the end.

You can adjust the reporter behavior by following this documentation.

Next Steps

Congratulations on generating and executing your first Skyramp test! To learn more about the generated test and understand customization options, please visit the Integration Test Documentation.

Let’s automate testing together!

Execute your Test

You can execute the generated tests without any additional adjustments to the code. However, based on the application you want to test, you can pass your authentication token to Skyramp Tests via an environment variable.

Set environment variable for authentication header

To test against an application that requires authentication, pass your token using our environment variable. By default, Skyramp expects a Bearer Token but we support additional authentication methods (Example 3). If your API does not require any authentication, you can skip this step and just run the test.

Skyramp’s sample application requires a session identifier. Quickly obtain your session_id via the Demo Shop UI and set it as your authentication header. Additional information and ways to obtain the session_id can be found here.

export SKYRAMP_TEST_TOKEN=$your_auth_token

Run the Test

Now you can run the tests using Playwright. If you don’t have Playwright, refer to the Installation Guide for setup instructions:

npx playwright test products_integration_test.spec.ts --reporter

Your integration test will perform the following sequence of actions:

Creation: Adds a new product to the Demo Shop.
Retrieval: Confirms the product has been successfully added.
Update: Modifies details of the created product.
Deletion: Deletes the created and modified product.

The test automatically identifies the relevant path parameters, intelligently chains the different requests together, and executes the test against the specified URL.

Review Test Results

By default, TypeScript’s List reporter provides clear and concise output indicating the success or failure of each step executed:

Each executed test will be displayed clearly in the terminal.
All encountered errors or issues will be summarized for easy debugging at the end.

You can adjust the reporter behavior by following this documentation.

Next Steps

Congratulations on generating and executing your first Skyramp test! To learn more about the generated test and understand customization options, please visit the Integration Test Documentation.

Let’s automate testing together!

Execute your Test

You can execute the generated tests without any additional adjustments to the code. However, based on the application you want to test, you can pass your authentication token to Skyramp Tests via an environment variable.

Set environment variable for authentication header

To test against an application that requires authentication, pass your token using our environment variable. By default, Skyramp expects a Bearer Token but we support additional authentication methods (Example 3). If your API does not require any authentication, you can skip this step and just run the test.

Skyramp’s sample application requires a session identifier. Quickly obtain your session_id via the Demo Shop UI and set it as your authentication header. Additional information and ways to obtain the session_id can be found here.

export SKYRAMP_TEST_TOKEN=$your_auth_token

Run the Test

Now you can run the tests using Playwright. If you don’t have Playwright, refer to the Installation Guide for setup instructions:

npx playwright test products_integration_test.spec.ts --reporter

Your integration test will perform the following sequence of actions:

Creation: Adds a new product to the Demo Shop.
Retrieval: Confirms the product has been successfully added.
Update: Modifies details of the created product.
Deletion: Deletes the created and modified product.

The test automatically identifies the relevant path parameters, intelligently chains the different requests together, and executes the test against the specified URL.

Review Test Results

By default, TypeScript’s List reporter provides clear and concise output indicating the success or failure of each step executed:

Each executed test will be displayed clearly in the terminal.
All encountered errors or issues will be summarized for easy debugging at the end.

You can adjust the reporter behavior by following this documentation.

Next Steps

Congratulations on generating and executing your first Skyramp test! To learn more about the generated test and understand customization options, please visit the Integration Test Documentation.

Let’s automate testing together!

typescript

Explanation of Command

Execute your Test

Set environment variable for authentication header

Run the Test

Review Test Results

Next Steps

Related topics

Explanation of Command

Execute your Test

Set environment variable for authentication header

Run the Test

Review Test Results

Next Steps

Related topics

Explanation of Command

Execute your Test

Set environment variable for authentication header

Run the Test

Review Test Results

Next Steps

Related topics