Zelara API Gateway Microservice

The Zelara API Gateway Microservice serves as the central hub for managing API requests, authentication, rate limiting, caching, and billing functionalities for the Zelara AI platform.

Table of Contents

• Features
• Architecture
• Getting Started
  • Prerequisites
  • Installation
  • Running the Service
• Configuration
• API Documentation
• Contributing
• License
• Contact

Features

• API Routing: Efficiently routes incoming API requests to appropriate worker services.
• Authentication & Authorization: Secure endpoints using JWT and OAuth 2.0, with RBAC implementation.
• Rate Limiting: Controls the rate of incoming requests based on user subscription tiers.
• Caching: Utilizes Redis for in-memory caching to improve performance.
• Billing Integration: Seamless integration with Stripe for payment processing and subscription management.
• Logging & Monitoring: Comprehensive logging and monitoring using industry-standard tools.
• Error Handling: Consistent and informative error responses across all API endpoints.

Architecture

For detailed architectural information, refer to the Architecture Documentation.

Getting Started

Prerequisites

• Node.js v14.x or higher
• Redis v6.x or higher
• Docker (optional, for containerized deployment)
• Stripe Account for billing integration

Installation

Clone the repository:

git clone https://github.com/zelara-ai/zelara-api.git
cd zelara-api

Install dependencies:

npm install

Running the Service

Using Node.js

Set up environment variables by copying .env.example to .env and filling in the required values.

Start the server:

npm start

Using Docker

Build and run the Docker container:

docker-compose up --build

Configuration

Configuration options are managed via environment variables and configuration files. Refer to the Configuration Guide for detailed instructions.

API Documentation

API endpoints, request/response schemas, and error codes are documented using OpenAPI (Swagger). Access the interactive API docs at http://localhost:3000/api-docs when the server is running.

For detailed API specifications, see API Documentation.

Contributing

We welcome contributions from the community. Please read our Contributing Guidelines and Code of Conduct before submitting issues or pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

For any questions or support, please contact the development team at [email protected].