REST API Backend

Overview

The REST API Backend qBit allows you to connect external REST APIs as qqq data sources. Query external services using qqq's standard API, with automatic request/response mapping.

Features

• API Mapping - Map REST endpoints to qqq table operations
• Authentication - OAuth 2.0, API keys, and custom auth headers
• Response Mapping - JSONPath-based field extraction
• Pagination - Automatic handling of paginated responses
• Rate Limiting - Respect external API limits
• Caching - Optional response caching for performance

Use Cases

• Integrating third-party services as data sources
• Building unified APIs across multiple systems
• Migrating from external APIs to internal databases
• Creating data aggregation layers

Installation

qqq install qbit-rest-api --license YOUR_LICENSE_KEY

Configuration

Map an external API as a qqq table:

new QInstance()
   .withBackend(new RestAPIBackendMetaData()
      .withBaseUrl("https://api.example.com/v1")
      .withAuth(new BearerTokenAuth(System.getenv("API_TOKEN")))
      .withTable(new RestAPITableMapping()
         .withName("externalUsers")
         .withEndpoint("/users")
         .withFieldMappings(Map.of(
            "id", "$.user_id",
            "name", "$.full_name",
            "email", "$.contact.email"))));

Requirements

• qqq Framework 1.0+
• Java 21+
• Network access to external APIs
• QRunIO account with valid license key