Skip to main content

Sparrow API Testing Modes

Browser Agent Mode​

The Browser Agent represents a direct connection approach where your browser communicates directly with the target API through Sparrow. This mode is particularly valuable for developers working with local APIs, testing in development environments, and scenarios where CORS is properly configured. Think of it as a straight line between your browser and the API you're testing.

Cloud Agent Mode​

In contrast, the Cloud Agent introduces Sparrow's proxy server as an intermediary. Rather than your browser making direct API calls, all requests are routed through Sparrow's secure server infrastructure. This mode proves invaluable when working with production APIs, dealing with CORS restrictions, or testing APIs that haven't enabled CORS support.

Serveragent

The CORS Challenge and Cloud Agent Solution​

CORS (Cross-Origin Resource Sharing) presents a significant challenge in web development. When your browser attempts to make API requests across different domains, CORS security policies can block these requests. For instance, if your web application runs on localhost:3000 and needs to communicate with api.example.com, the browser will block this cross-origin request unless the API explicitly permits it.

This is where Cloud Agent provides an elegant solution. Instead of attempting direct browser-to-API communication, your request takes a different path: first to Sparrow's proxy server, which then makes the actual API request, and finally returns the response to your browser. This approach effectively bypasses CORS restrictions while maintaining security.

Connection Patterns Across Protocols​

The connection patterns vary depending on your chosen protocol.

  • REST APIs:

    • Browser Agent establishes a direct connection from browser to API.
    • Cloud Agent routes requests through the proxy.

  • WebSocket Connections:

    • Browser Agent creates direct WebSocket connections.
    • Cloud Agent establishes connections through the proxy server.

  • Socket.IO Implementations:

    • Browser Agent handles direct connections.
    • Cloud Agent facilitates connections through the proxy.

Understanding these modes and their appropriate use cases allows developers to effectively navigate API testing scenarios while maintaining security and functionality. The choice between Browser Agent and Cloud Agent ultimately depends on your specific testing environment, security requirements, and the APIs you're working with.