Skip to main content
Version: 1.0.8

SmartAPI

SmartAPI dashboard and current module navigation

SmartAPI turns API descriptions and requests into reviewed automation. It analyzes a source into an endpoint inventory, lets you correct that inventory, generates test scenarios against the part of it you choose, and saves the ones you approve into AutoRunner.

SmartAPI lives under the /smart-api URL prefix.

SmartAPI areas​

AreaPathUse it to
Dashboard/smart-api/dashboardSee workspace totals for sessions, endpoints, generated scenarios, and saved scenarios.
File Management/smart-api/filesUpload, version, and reuse API source files.
Inventory/smart-api/inventoryInspect endpoints, fields, and relationships; edit them in a draft and publish a version.
API Test Generation/smart-api/test-generationChoose a scope, design the tests, and generate scenarios.
Sessions/smart-api/sessionsFollow analysis and generation runs and open their results.
Scenarios/smart-api/scenariosBrowse, edit, and regenerate the scenarios saved to AutoRunner.
Settings/smart-api/settingsSet naming standards and generation defaults for the workspace.

Generated assets are described in more detail under Generated Tests and Flows, Requests, Assertions, and Captures, Variables and Environment Input, and AutoRunner Transfer.

Supported source formats​

SmartAPI accepts:

  • OpenAPI or Swagger;
  • Postman collections;
  • HAR, including HAR-like exports from Charles or Fiddler;
  • WSDL;
  • GraphQL;
  • Protobuf;
  • AsyncAPI; and
  • cURL requests pasted directly into a generation workspace.

Up to 5 files can be added at once, each up to 10 MB. Uploaded files are analyzed automatically.

End-to-end workflow​

  1. Confirm the active RabbitQA workspace.
  2. Upload a source in File Management, or add it inline while starting a generation.
  3. Let analysis run, then review the result in Inventory — endpoints, services, relationships, and security schemes.
  4. Confirm or reject the proposed relationships, correct anything analysis got wrong, and publish the inventory version.
  5. In API Test Generation, choose the scope: a published inventory version, a new upload, or pasted cURL.
  6. Review the discovered services and select the endpoints to cover.
  7. Design the tests with a prompt, a Sanity/Smoke/Regression template, or an import from the test repository, then generate.
  8. Follow the run in Sessions, review each generated scenario, and save the ones you want into an AutoRunner folder.
Generation is a draft, not execution proof

Generated assertions and flows must be reviewed against the intended API contract. SmartAPI produces automation; whether it passes is established in AutoRunner.

Generation can call your real API

Execute API requests during generation is a workspace default that can be changed per session. While it is on, generation sends real requests, which may create, change, or delete data.

Start with SmartAPI Quick Start, then use Correct Use and Best Practices for the review gates that protect shared workspaces.