ApiPlatform Module

Installation

composer require spryker/api-platform

The authoritative documentation lives in spryker-docs. Start here:

API Platform overview — concepts, architecture, and the resource generation workflow.
Resource schemas — *.resource.yml reference.
Validation schemas — *.validation.yml reference.
Relationships — declaring includes between resources.
CodeBucket support — region-specific resource variants.
Testing — writing tests for API Platform resources.
IDE integration — PHPStorm and VSCode setup for YAML autocomplete.
Integration guide — installing and configuring API Platform in a project.
Migration from Glue REST — moving legacy endpoints to API Platform.
Troubleshooting — common issues and solutions.