Quick Start Guide

Overview

API Aggregator is a powerful tool that helps you manage and integrate multiple APIs into a single, unified interface. This quick start guide will help you get up and running in minutes.

Prerequisites

• Node.js 18.0 or higher
• npm or yarn package manager
• Basic understanding of REST APIs

Step-by-Step Guide

1. Install API Aggregator

npm install @api-aggregator/core

2. Initialize Your Configuration

npx api-aggregator init

3. Configure Your First API

Edit the api-config.json file created in your project root:

{
  "apis": {
    "example-api": {
      "baseUrl": "https://api.example.com/v1",
      "auth": {
        "type": "bearer",
        "token": "YOUR_API_KEY"
      }
    }
  }
}

4. Start Using API Aggregator

Import and use API Aggregator in your code:

import { APIAggregator } from '@api-aggregator/core';

const apiClient = new APIAggregator();
await apiClient.initialize();

// Make your first API call
const response = await apiClient.call('example-api', '/users');

Next Steps

Now that you have API Aggregator set up, you can:

• Add more API configurations
• Set up authentication methods
• Create API route mappings
• Implement error handling

For more detailed information, check out our installation guide or learn how to create your first API integration.