DOCSEARCHbyAlgolia
Submit Docs

Sparrow User Manual

website·Indexed 33 days ago

https://docs.sparrowapp.dev

A cross-platform API development tool for managing REST, GraphQL, WebSocket, and Socket.IO requests. Features include a mock server, Test Flows for behavior validation, an AI Studio for generating documentation and mock data, and a community marketplace for public workspaces. Supports desktop installation on Windows, macOS, and Linux, as well as self-hosting via Docker.

Tokens
51.6K
Snippets
128
Records
461
Agent score
59%

What's inside Sparrow

  1. Overview of GraphQL features

    GraphQL is a modern API query language and runtime used for fetching precise and flexible data via a single endpoint. Key features include declarative data fetching, a strongly typed schema, and version-free evolution.

  2. Overview of Sparrow API Excellence Platform

    Sparrow is an AI-powered API development platform designed for building, testing, documenting, and debugging APIs. It supports REST, GraphQL, and WebSocket APIs and is available as a web application, a native desktop app (macOS, Windows, Linux), or via self-hosting on private infrastructure for maximum security and GDPR compliance.

  3. Overview of Sparrow Admin Panel Modules

    The Sparrow Admin Panel provides a centralized interface for administrators and hub/workspace managers to control organization-wide settings. It consists of three primary modules:

    1. Hub Management: Used to manage and monitor all connected hubs from a single location.
    2. User Management: Used to control user access and permissions within the organization.
    3. Billing: Used to track usage and manage subscription plans.

  4. Overview of Sparrow Workspaces

    Workspaces in Sparrow are used to organize API requests, collections, and environments by project or purpose. They allow users to maintain separate environments for different stages (e.g., development, staging, production) and support both individual and team-based collaboration by allowing users to switch between personal and shared team workspaces.

  5. Overview of the Sparrow Marketplace

    The Sparrow Marketplace is a centralized directory of public workspaces shared by the community. It allows developers to discover and test ready-to-use API collections, environments, and test flows. All marketplace workspaces are identified by a persistent 'Public' tag and are available on both desktop and web versions.

  6. Overview of Sparrow Test Flow

    The Test Flow feature in Sparrow is used to build and manage sequences of API calls to validate API behavior. It allows users to chain multiple test steps (blocks) together, execute them in order, and analyze the results.

  7. Overview of Generate Variables feature

    The Generate Variables feature analyzes an API collection to identify reusable values and automatically suggests corresponding variables. It converts static, hardcoded values into dynamic references using the {{variable}} syntax, allowing for centralized management of base URLs, authentication tokens, and configuration parameters across multiple requests.

  8. Overview of Sparrow API Platform

    Sparrow is an AI-powered, lightweight API excellence platform used for building, testing, documenting, and debugging APIs. It is designed for backend engineers, QA teams, product/API teams, and DevOps engineers working with REST, GraphQL, and WebSocket APIs.

  9. Overview of Sparrow API Excellence Platform

    Sparrow is an AI-powered, lightweight API development platform designed for building, testing, documenting, and debugging APIs. It supports REST, GraphQL, and WebSocket APIs and is available as a web application, a native desktop app (macOS, Windows, Linux), or via self-hosting on private infrastructure.

  11. Overview of Sparrow Active Sync

    Active Sync allows Sparrow collections to maintain a real-time synchronization with a remote Swagger or OpenAPI definition hosted via a Swagger or localhost URL. This prevents drift from the source of truth and ensures APIs remain up to date.

    Key constraints and capabilities:

    • Supports only Swagger or localhost links.
    • Disables manual adding or deleting of requests to maintain structural integrity.
    • Allows editing of request properties (e.g., headers, params) and testing.
    • The collection structure mirrors the remote definition.

  12. Overview of Sparrow Edge

    Sparrow Edge is a lightweight, login-free mode of Sparrow designed for users to instantly test APIs and explore core features without creating an account. It provides an ephemeral workspace that runs locally, avoiding cloud syncing for faster performance. It is primarily used for quick API functionality tests and evaluating the interface before signing up for a full account.