Getting Started
UI Update Notice
ReadyAPI 4.0.0 introduced a refreshed user interface.
During the documentation update process, some screenshots and videos may display the previous UI. Functionality and workflows remain unchanged.
ReadyAPI is a unified platform for functional, security, performance, and virtualization testing of APIs. This guide gets you to a working test as quickly as possible and points you to the right resources based on your situation.
Before you begin
You need a ReadyAPI license - trial or commercial - to run the product. If you are evaluating ReadyAPI, your trial licence activates automatically when you register at the SmartBear portal. There is nothing to install separately.
Minimum system requirements: 64-bit OS (Windows, Linux, or macOS), Intel Core i5/i7 3rd gen or equivalent, 16 GB RAM, Adoptium JDK 21 (bundled with the installer). See System Requirements for full details.
Choose your path
I am... | Do this |
|---|---|
New to ReadyAPI | Follow the Quick Start below. You will import an API, create a test case, and run it in under ten minutes. |
Setting up for my team | Go to the Installation Guide, then Licensing, then Automate API tests for CI/CD configuration. |
Migrating from SoapUI | Your existing SoapUI projects are compatible. See Move to ReadyAPI from SoapUI for what changes and what you gain. |
Connecting an AI assistant | See MCP Integration. The Model Context Protocol (MCP) Server ships with ReadyAPI 4.x and requires no separate installation. |
Quick Start: your first functional test
The fastest way to validate your API is to build a functional test. This section walks you through the core steps.
Step 1 - Create a project
To create a project, do the following:
Open ReadyAPI.
On the Project Starter tab, click New Project, then select Import from URL or file.
Paste in an OpenAPI spec URL, or point to a local file.
ReadyAPI parses the spec and creates a project with your API's endpoints already mapped.
Step 2 - Generate a test suite
To generate a test suite, do the following:
Right-click your API in the project navigator.
Select Generate Test Suite.
ReadyAPI creates a test case for each endpoint. Accept the defaults to proceed.
Step 3 - Add an assertion
To add an assertion, do the following:
Open a test case.
Click Add Assertion.
Choose HTTP Status Assertion.
Set the expected code to 200.
This confirms the endpoint responds correctly.
Step 4 - Run the test
Click Run in the test case toolbar. ReadyAPI executes the request, validates the assertion, and reports whether the request passes or fails in the results panel.
Step 5 - Review results
The results panel shows the HTTP response, response time, and assertion outcome. Click any result row to inspect the full request and response. Your first test is complete.
Next Steps
Data-driven testing: see Data Sources.
Chained test suites: see Test Suites and Cases.
Running in CI/CD: see Automate API Tests.
Security scanning: see Security Tests.
Service virtualization: see ReadyAPI Virtualization and VirtServer.
Load testing: see ReadyAPI Performance.
AI-assisted authoring: see MCP Integration.