Table of Contents
We are excited to introduce RapidAPI Testing — a functional API testing solution for creating and managing comprehensive API tests from development to deployment. Tests can be run for any type of API (including REST, SOAP, and GraphQL).
Why We Built RapidAPI Testing
The growth of the RapidAPI Enterprise Hub has given our team the opportunity to work with companies of all sizes and across many different industries. One common question customers asked was how the Enterprise Hub would fit in their broader API management strategy, and if we could recommend any API testing solutions.
As we looked at available API testing options, we found that none of the existing testing vendors combined comprehensive testing, global monitoring, and seamless integration adequately for the needs of enterprise customers. We realized we could solve these problems by offering RapidAPI Testing.
Further, we saw the opportunity to offer tight integrations to the RapidAPI Marketplace and RapidAPI Enterprise Hub. This makes it easy for existing and new RapidAPI users to manage their APIs from a single platform, with a single API key, and a single SDK.
With RapidAPI Testing, you can create custom API test flows in a variety of ways. Pick the method that works best for you, from the visual drag-and-drop editor, the code based editor, or automatic test generation based on the API specification.
Your team can create intricate test flows and perform deep validation of APIs with the drag-and-drop editor — even if they aren’t programmers.
Code-Based Editor and Granular Control
Refine your testing flows with a code-based interface or with custom code executions in test flows.
Schedule tests with the ability to control frequency, environment, and location.
Automatic Test Generation
API properties can be inferred and used to automatically generate tests.
Call multiple API endpoints and chain data between them to mimic real application behavior.
Secure every step of the testing process with object-level authorization, header validation, and user authentication.
Use RapidAPI Testing to continuously monitor all API tests with sophisticated reporting and analytics — including detailed execution reports and an intuitive management dashboard.
World-Wide Data Centers
Monitor performance across 9 AWS regions, with Microsoft Azure locations coming soon.
SMS & Email Alerts
Set up custom alerts to notify you if tests fail. You can also integrate with existing incident management tools including PagerDuty, Slack, and Twilio.
Detailed Reporting and Logs
View detailed analytics to pinpoint and resolve issues. Log every API test to understand which endpoints are driving application latency.
Intuitive Management Dashboard
Manage all your tests in one place with the easy-to-understand Management Dashboard.
RapidAPI Testing automatically syncs with the RapidAPI Marketplace and RapidAPI Enterprise Hub to ensure test coverage across all of an organization’s APIs. You can also improve development efficiency with built-in collaboration capabilities and a dedicated webhook for integration across your CI/CD pipeline.
Integrate to a CI/CD pipeline with a dedicated webhook
Organize developers into teams, assign API and test permissions at team and role level, and enable real-time collaboration for running tests and viewing analytics.
Marketplace/Enterprise Hub Integration
Seamlessly integrate with existing APIs in your RapidAPI Enterprise Hub or personal developer account on RapidAPI.com.
How to Automatically Generate Your First Test
Step 1: Navigate to RapidAPI Testing and Select the API to Test
RapidAPI Testing integrates directly with the RapidAPI Marketplace. All of your personal APIs (and any Organization APIs you have access to) will appear on the RapidAPI Testing Dashboard.
Click the desired API to get started.
Step 2: Click “+ Create Test”
Click “+ Create Test” and name the test.
Step 3: Open the Request Generator
Open the Request Generator at the bottom of the screen.
Alternatively, you can click “+ Add Step” and use the visual editor and drag-and-drop features to create the test flow. You can also switch to the code editor if desired. For this tutorial, we will use the Request Generator.
Step 4: Select the Desired Endpoint
Pick the desired endpoint from the left-hand column.
Most of the information, like the request URL, parameters, and headers will auto-populate. If necessary, fill out the parameters as desired or add additional parameters using the “+” icon.
Step 5: Add the Request to the Test
After you have filled out the required fields, click the “Add to Test” button in the bottom right. Select the assertions to insert into the test. In our demo, we included headers.content-type and status. You can refine the test by selecting the Assertion Type in the right side dropdown.
Click “OK” to add the assertions to the test.
Step 6: Edit and Run the Test
Use the Visual Editor or the Code Editor to make any desired changes to the test. For this demo, we did not make any changes.
Click the “Run” button in the top right corner to run the test.
Step 7: View the Test Report
After the test is completed, you can click on the test results to view a status report.
Recommended Step: Schedule the Test to Occur in Regular Intervals
If desired, schedule the test to occur at regular intervals. This can help you track the API performance over time.
Navigate from the Test Editor to the Test Scheduling tab.
Select the frequency of the test, the test environment, and the locations the test will execute in. In our example, we set the test to occur every 5 minutes in the default environment and the local location.
Recommended Step: Set SMS or Email Alerts
If desired, set SMS or Email notifications to be sent to you if a test fails. Navigate to the Settings page and scroll down to the alerts section. You can toggle between Email or SMS alerts using the tab.
The Settings page is also where you can configure different Test Environments if desired.
Recommended Step: View Test Analytics
You can view the Analytics for all of your tests from the Analytics Dashboard. This will provide information on test volume and success rate.
Get Started with RapidAPI Testing Today
It is easy to get started with RapidAPI Testing, whether or not you already have an existing RapidAPI account. Try RapidAPI Testing for free at https://rapidapi.com/testing.
If you need more tests, calls, or features than the free plan provides, pick from one of our existing pricing plans or contact our team for a custom enterprise plan. RapidAPI Testing is available as an add-on to the RapidAPI Enterprise Hub or as a standalone self-service product.
For information about more advanced testing settings, check out the RapidAPI Testing documentation. You can also contact our support team at [email protected], or share feedback with our team on Twitter at @Rapid_API. Happy testing!