# api-platform

**Repository Path**: mirrors_wso2/api-platform

## Basic Information

- **Project Name**: api-platform
- **Description**: AI-ready, GitOps-driven API platform for full lifecycle management across cloud, hybrid, and on-prem.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-04
- **Last Updated**: 2026-05-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# WSO2 API Platform

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![GitHub last commit](https://img.shields.io/github/last-commit/wso2/api-platform.svg)](https://github.com/wso2/api-platform/commits/main)
[![GitHub issues](https://img.shields.io/github/issues/wso2/api-platform.svg)](https://github.com/wso2/api-platform/issues)
[![codecov.io](https://codecov.io/github/wso2/api-platform/coverage.svg?branch=main)](https://app.codecov.io/github/wso2/api-platform?branch=main)
[![Performance](https://img.shields.io/badge/Performance-Benchmark-success)](https://github.com/wso2/api-platform/blob/main/docs/performance/README.md)

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](docs/images/Govern-your-APIs.webp)

## Documentation

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

- [Gateway Documentation](docs/gateway/README.md)
- [Gateway Quick Start](docs/gateway/quick-start-guide.md)
- [AI Gateway Documentation](docs/ai-gateway/README.md)
- [AI Gateway LLM Quick Start](docs/ai-gateway/llm/quick-start-guide.md)
- [AI Gateway MCP Quick Start](docs/ai-gateway/mcp/quick-start-guide.md)
- [CLI Quick Start](docs/cli/quick-start-guide.md)

## 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.