API Test Builder

From API Spec to Test Script in Seconds.

Stop writing boilerplate. Automatically generate API test scripts for Cypress and Playwright directly from your Swagger/OpenAPI documentation.

VSCode logo Install on VS Code

Available on the VS Code Marketplace

How It Works

Animation of the API Test Builder extension in VS Code: a user right-clicks a Swagger file, selects 'Swagger to Cypress', and a new folder with test scripts is instantly generated.

Automate Your API Test Setup

Generate Tests Instantly

Creates complete test scripts for Cypress and Playwright based on your Swagger or OpenAPI specification file.

Organized by Tag

Automatically groups generated tests into folders based on the tags defined in your API specification.

Handles Schema References

Correctly resolves and processes internal schema references (`$ref`) within your API definitions.

Includes Basic Assertions

Adds `expect` statements to check the response status code, giving you a solid foundation for your tests.

From JSON to Test Suite in 3 Steps

1. Open Your Swagger File

Open your OpenAPI 3.0 or Swagger 2.0 JSON documentation file directly in VS Code.

2. Right-Click and Choose

Right-click anywhere in the editor, find the "API Test Builder" menu, and select your target (Swagger to Cypress or Swagger to Playwright).

3. Voilà! Tests Generated

The extension instantly creates the directories and test script templates. Just add your scenarios!

Frequently Asked Questions (FAQ)

Yes, it is 100% safe and private. The extension processes your Swagger/OpenAPI JSON file entirely locally within your VS Code instance. No data from your API specification is ever transmitted to any external server.

API Test Builder supports the most widely used versions of the specification: OpenAPI 3.0 and the legacy Swagger 2.0. Simply open your JSON specification file and the extension will handle the parsing.

The extension generates the complete boilerplate and structure for your tests, including folders, request definitions, and basic status code assertions. It creates the foundation so you can focus on adding your specific test scenarios and business logic, saving you significant setup time.

Yes! The extension is perfect for learning and experimentation. You can use the official Swagger Petstore examples (both v2.0 and v3.0) to see how it works instantly. Links are provided in the documentation.

Stop writing boilerplate and start testing your API.

VSCode logo Install Free on VS Code