Skip to content

Introduction

Welcome to OpenPlatform, a next-generation microservices gateway built entirely on Cloudflare Workers.

What is OpenPlatform?

OpenPlatform acts as a centralized API Gateway that manages Authentication, Rate Limiting, Usage Analytics, and Billing for a suite of distributed microservices. Unlike traditional monolithic architectures, OpenPlatform is serverless, running on the edge to ensure low latency and high availability.

Architecture Overview

  1. Gateway (my-gateway): The entry point. Handles all incoming traffic, validates API Keys, and routes requests to the appropriate service worker.
  2. Services: Independent workers (e.g., File Service, Bot Service) that handle specific business logic.
  3. Console: A management dashboard for users to provision API keys, view analytics, and manage service instances.

Key Features

  • 🔐 Unified Authentication: Single API Key to access all services.
  • 📈 Usage Analytics: Real-time traffic monitoring via Cloudflare Analytics Engine.
  • 💰 Billing System: Dynamic cost calculation and ledger tracking.
  • 🧩 Service Polymorphism: Services adapt their behavior based on configuration (e.g., Public vs Private file buckets).

Getting Started

Visit the Management Console to generate your first API Key.