Anypoint API Specifications

This repository is the single source of truth for all public Anypoint Platform API specifications. It contains OpenAPI (OAS) specifications for all production-accessible APIs.

Purpose

• Centralized registry of all public Anypoint Platform APIs
• Ensures API specifications are validated and compliant with AI-agent-friendly standards
• Enables API discovery and consumption through standardized, well-documented specs
• Provides version control and change tracking for API specifications

Repository Structure

Each API service has its own directory containing:

/
├── api.yaml           # Main OpenAPI specification file
├── exchange.json      # Exchange metadata (groupId, assetId, version, etc.)
├── schemas/           # Reusable schema definitions (optional)
├── examples/          # Request/response examples (optional)
└── skills/            # JTBD workflow skills (optional)

The repository also includes shared tooling:

scripts/
├── portal_generator/  # Static API documentation portal generator
├── tests/             # Portal generator test suite (pytest)
├── generate_portal.py # Entry point for portal generation
├── requirements.txt   # Python dependencies
└── pyproject.toml     # Pytest configuration

Getting Started

Prerequisites

• Node.js and npm installed (for Anypoint CLI)
• Anypoint CLI v4 with API Project plugin
• Python 3 (for portal generator and validation scripts)
• Claude Code CLI (for validation skills)

Installing Required Tools

1. Install Anypoint CLI v4:

npm install -g anypoint-cli-v4
anypoint-cli-v4 plugins:install anypoint-cli-api-project-plugin

2. Install Python dependencies:

pip3 install -r scripts/requirements.txt

Using a Homebrew-managed Python (macOS)? Homebrew’s Python is marked as an “externally-managed” environment (PEP 668), so a bare pip3 install will refuse to write into it. Use a local virtual environment instead (see Generating the Portal with Homebrew-managed Python below).

3. Install API Spec Validation Skills:

# In Claude Code CLI
/plugin marketplace add machaval/api-spec-skills

This installs the api-spec-validator skill which validates specs against AI-agent-friendly best practices using Anypoint CLI under the hood.

4. Git hooks (automatic):

Git hooks are automatically configured the first time you run any make command. Pre-commit runs fast validators (~2-5s) and pre-push runs tests + governed validation. See make help for skip options.

Makefile Commands

The Makefile provides convenient shortcuts for common tasks:

make help                  # Show all available targets
make validate-all-governed # Validate all APIs with governance rules
make validate-api API=name # Validate a specific API
make list-apis             # List all discovered APIs