Quickstart
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.
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
Since the Skyramp Demo Shop does not require any authentication, you can immediately execute the generated test using Playwright’s list reporter:
npx playwright test products_integration_test.spec.ts --reporterYour 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!
Related topics
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.
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
Since the Skyramp Demo Shop does not require any authentication, you can immediately execute the generated test using Playwright’s list reporter:
npx playwright test products_integration_test.spec.ts --reporterYour 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!
Related topics
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.
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
Since the Skyramp Demo Shop does not require any authentication, you can immediately execute the generated test using Playwright’s list reporter:
npx playwright test products_integration_test.spec.ts --reporterYour 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!