Quick Start Guide

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 helps you validate and improve API quality. It combines tools that support different types of testing:

Functional tests verify that your service works as expected.
Security tests verify how your service resists cyberattacks.
Load tests check whether your service can handle high user traffic.
Virtual services simulate the real behavior of your service before it is created.

Use this guide to learn core workflows and start testing from day one.

Start with Functional Testing

Start here. This is the fastest way to validate your API and see product value.

In this quick start, you will learn how to:

Import your API
From the Home tab:
1. Click Functional Test.
2. Select your API definition file (OpenAPI, Swagger, WSDL, or Postman collection).
Create a test suite and a test case
After you import the API, ReadyAPI creates a test suite automatically.
1. Add the test suite to an existing project or create a new one.
2. Verify that ReadyAPI added the project to your workspace.
3. Add a test case to verify specific functionality.
Add assertions
Use assertions to validate response data:
- HTTP status
- JSON or XML structure
- Schema validation
- Smart Assertions for automated analysis
Run and analyze
Click Run:
- View results in the test runner panel
- Review assertion feedback
- Fix or extend tests as needed

To extend your functional test with a security scan, start with 1. Create and Run.

You will learn how to:

To simulate traffic and measure performance, start with 2. Load Test Editor Interface.

You will learn how to:

To create mock APIs for development and testing, start with Understanding Basic Concepts.

You will learn how to:

After you complete these quick starts, do the following: