What does this plugin do?
- Parses any OpenAPI/Swagger JSON specification and generates a complete Katalon Studio test suite from it — Web Service Request objects and API Test Cases, one per endpoint.
- Replaces hours of manual object creation, parameter wiring, and verification scripting with a guided wizard that runs in minutes.
- Groups generated objects and test cases by tag, mirroring the structure of your specification.
Core Workflow
- Import & Validate — browse to your OpenAPI/Swagger JSON file; the plugin parses and validates it immediately.
- Server URL & Authentication — automatically detected from your specification (server URL pre-filled, authentication type pre-selected as No Auth, Basic Auth, or Bearer Token), with the option to review or override any value.
- Choose Test Case Type — select any combination of Basic API Test Case, Parameter Validation, and Schema Validation.
- Generate — live progress feedback as objects and test cases are created, followed by a summary of everything generated.
Features and Capabilities
- Automatic object and test case generation, one per API operation, organized by tag/folder.
- Smart defaults for server URL and authentication scheme, reducing manual configuration.
- Centralized Server URL management — the server URL, whether detected from your specification or entered manually, is always stored in a single Katalon Global Variable and referenced by every generated Web Service Request; no request ever hardcodes a URL.
- Environment switching without regeneration — because every request reads the server URL from a Global Variable, moving between Dev, QA, UAT, and Production is just a matter of switching Katalon Execution Profiles.
- Flexible URL input — accepts a server URL with or without a trailing slash (
https://hostorhttps://host/); both forms resolve identically, so generated requests never end up with a malformed double-slash path.- Independently configurable validation depth — toggle parameter validation and response schema validation per generation run.
- Secure credential handling — credentials and tokens are stored as protected Katalon Global Variables, never hardcoded into test scripts.
- Clear, self-narrating generated test scripts — each step (parameter checks, request/response logging, status code verification, schema validation) logs its own pass/fail evidence.
- Full
$refresolution — nested and shared schema components are resolved during parsing, so modular specifications are handled correctly.- Stable regeneration — object and test case identifiers are derived deterministically from their own paths, so re-running the wizard after a spec update doesn't create noisy, unrelated changes.
- Non-blocking validation — a spec that fails to validate doesn't trap you; you can still proceed, with a definitive error only if generation itself can't complete.
- No external scripting runtime required — the generation engine is implemented entirely in Java, running natively within Katalon's plugin architecture.
Who Is It For?
- QA engineers and SDETs working with REST APIs who want a baseline of automated API tests directly from existing OpenAPI documentation.
- Teams onboarding a new service, keeping tests in sync as an API evolves, or bootstrapping test coverage for an API that has none yet.
How to Install This Plugin from the Store
- Open Katalon Studio and go to the Store tab (or Profile → Katalon Store, depending on your version).
- Search for "OpenAPI Test Generator".
- Click Install on the plugin listing and accept any permission prompts.
- Restart Katalon Studio once installation completes — plugin installs only take effect after a full restart.
- After restarting, open any Katalon project and look for the OpenAPI Test Generator icon on the toolbar to launch the wizard.
Visit Katalon Forum for Plugin related discussions.