Skip to content

README.md

Latest commit

 

History

History
104 lines (79 loc) · 4.15 KB

README.md

File metadata and controls

104 lines (79 loc) · 4.15 KB

WSO2 API Platform

License GitHub last commit GitHub issues codecov.io Performance

AI-ready, GitOps-driven API platform for full lifecycle management across cloud, hybrid, and on-premises deployments.

Overview

The WSO2 API Platform is a complete platform that helps organizations build AI-ready APIs with comprehensive lifecycle management capabilities. The platform supports deployment on the cloud, fully on-premises, or in hybrid mode.

Platform Scope

The API Platform covers the complete API lifecycle:

  • ✅ API ideation and planning
  • ✅ API design and documentation
  • ✅ API deployment handling
  • ✅ API testing and mocking
  • ✅ Runtime management (ingress and egress)
  • ✅ API governance and compliance
  • ✅ Asset discovery and consumption
  • ✅ API analytics and monetization

Key Principles

  • Developer experience is king: Optimized workflows and UX for all users
  • Size matters, keep it as small as you can: Minimal footprint for all components
  • Same control plane/UI experience across cloud and on-premises: Consistent interface regardless of deployment model
  • Platform components are independent: No hard dependencies between components
    • Treat each component as a product itself
  • GitOps ready: Configuration as code for both API configs and gateway configs
    • Separation of Concerns: Spec vs. Execution
  • AI-Ready by design: Servers are MCP enabled for AI agent integration
  • Docker as the shipping vehicle: All components distributed via Docker containers
  • API Gateway:
    • Based on Envoy Proxy
    • Apart from basic proxy features (routing, TLS, etc), everything else is a policy
  • API Policies: GoLang based API Policies with Policy Hub support

Architecture

High-Level Architecture

High-Level Architecture Diagram showing system components and data/control flows

Documentation

Refer to the documentation for setup guides, component-specific quick starts, and usage details.

Platform Components

API Designer

Standalone design tool for REST, GraphQL, and AsyncAPI specifications.

Key Features:

  • Code + visual split view with real-time updates
  • AI-assisted specification and documentation generation
  • Built-in mocking and governance checks
  • AI-readiness score for APIs
  • MCP code generation from specifications

Management Portal

Central control plane for managing gateways, APIs, policies, and governance.

Key Capabilities:

  • Gateway management and orchestration
  • API lifecycle management
  • Policy and governance rule management
  • Identity provider configuration
  • API deployment to gateways
  • Publishing to developer portals

API Gateway

Envoy-based API gateway for securing and routing API traffic.

Key Features:

  • Built on Envoy Proxy
  • Policy-first architecture (auth, rate limiting, analytics)
  • Runs on VMs, containers, Kubernetes
  • Single-tenant mode
  • Optimized for AI/agentic flows

API Developer Portal

Developer portal for API discovery, subscription, and consumption.

Key Features:

  • API catalog and semantic search
  • Try-it console for API testing
  • API subscription management
  • Application and API key management
  • AI-powered discovery

(c) Copyright 2012 - 2026 WSO2 Inc.