Introduction

---

Requestly is an open-source tool for API Mocking, Testing, and Debugging. It serves as a valuable companion for developers, offering the following features:

• Send API requests using the API Client

• Create, manage, and collaborate on API contracts

• Override APIs by modifying headers, request bodies, response bodies, status codes, and adding delays

• Mock API responses

• Record Bug Reports

This documentation provides official information on incorporating Requestly into your development workflows.

Below is an introduction to each section of this documentation, allowing you to quickly navigate to the solution you need.

Getting Started

If you are new to Requestly, We recommend you start with the getting started section.

API Client

Send API Request

Use Requestly to send requests to the APIs you're working with. Learn more about Send API requests and get response data in Requestly.

Design APIs

Requestly supports designing APIs using its API Builder embedded into API Client. Designing APIs in Requestly helps you streamline the rest of the development flow like testing, mocking, and debugging your APIs.

Support of collections, environments, and scripts lets you design your API contracts quickly. Your API definition can serve as the single source of truth for your projects. Sharing APIs within or across teams is fast and easy.

Start designing your APIs in Requestly using API Builder.

Develop APIs

Use Requestly to help you during API development, learn how to use Requestly to speed up API Development.

Using Variables

Use variables to control the variable parts of API Requests, such as the root URL, tokens, etc., that vary across environments. Learn more under environment variables. Requestly also supports collection-level variables for use within a collection.

HTTP Rules

Override APIs / Network Calls

Requestly offers powerful HTTP Rules that enable you to modify network requests and responses effortlessly. You can override headers, edit the request body, customize the response body, or even change the response status code quickly. Additionally, you can modify query parameters to add, update, or delete parameters in a URL, and modify user-agent strings to simulate different devices or browsers. You can also cancel requests before they are executed.

Explore Modify Headers, Modify Query Parameters, Modify User-Agent, Modify Request Body, Modify API Response, and Cancel Request for step-by-step instructions and examples.

Redirect Network Calls/APIs

Requestly provides two ways to redirect a network request, whether it is a script file, image, API, or any other resource. The Redirect Rule matches URL conditions and redirects all matching requests to a predefined URL. The Replace Rule is more versatile, allowing you to match a URL, replace a part of it to create a new URL and redirect the request to this newly constructed URL.

Add Network Delay

You can simulate network delays using the Delay Rule, which allows you to add a delay (in milliseconds) to matching URLs. This is particularly helpful for testing your application's behavior under slow network conditions or during a slow process.

Insert Scripts

The Insert Scripts Rule in Requestly enables you to make dynamic, on-the-fly changes to a webpage’s content or behavior without needing to access or modify the source code.

API Mocking

API Mocking enables you to simulate APIs for testing and development without depending on live backend systems. Requestly supports two types of API Mocking: Local Mocks, which can be created individually or in bulk by recording a live session for offline or quick testing, and Cloud-Based Mocks, which are hosted on Requestly’s platform for easy sharing and collaboration.

Team Collaboration

Requestly makes working with your team seamless and efficient. With Team Workspaces, you can add team members and share all resources, including HTTP Rules, saved sessions, API collections, environment variables, and mocks. Workspaces help you organize resources effectively and ensure effortless collaboration among team members.

Sessions

Requestly’s Sessions feature provides powerful tools for capturing, analyzing, and sharing network activity. You can record API sessions, replay them for testing, and even use them for bulk mocking. It also allows you to record bug reports, capturing screen activity, console logs, network logs, and environment details to create replicable bug reports for developers.

Additionally, you can import and view HAR files directly within Requestly for seamless analysis. To ensure security, sessions come with access control options, allowing you to manage who can view or use the recorded sessions.

Requestly Public API

Requestly's Public API enables seamless integration into your CI/CD pipelines, allowing you to programmatically manage HTTP rules for automated testing and deployments. With the API, you can add, update, delete, and retrieve rules, simplifying workflows like creating staging environments or updating configurations dynamically.

Imports

Requestly's Imports feature lets you easily migrate configurations from tools like Postman, Charles Proxy, Modheader, and Resource Override, unifying your workflows within a single platform.

Security & Privacy

At Requestly, we prioritize security and privacy across all aspects of our platform. Being open source, our codebase is transparent and auditable. Our robust infrastructure ensures reliable performance and data security, further backed by SOC 2 compliance for industry-standard safeguards. Learn more about the security and privacy measures implemented for the API Client, HTTP Rules, HTTP Interceptor, and Session Book in our detailed documentation.

Billing

Requestly's Billing section simplifies license and subscription management for teams. Through the Billing Team Dashboard, admins can assign or revoke licenses and manage roles like Billing Manager, Admin, and Member to streamline access and collaboration.