spryker/api-platform

ApiPlatform module

1.20.1 2026-06-05 13:03 UTC

Requires

• php: >=8.3
• api-platform/api-pack: ^1.4.0
• api-platform/doctrine-common: ^4.3.0
• api-platform/doctrine-orm: ^4.3.0
• api-platform/documentation: ^4.3.0
• api-platform/hal: ^4.3.0
• api-platform/http-cache: ^4.3.0
• api-platform/hydra: ^4.3.0
• api-platform/json-api: ^4.3.0
• api-platform/json-schema: ^4.3.0
• api-platform/jsonld: ^4.3.0
• api-platform/metadata: ^4.3.0
• api-platform/openapi: ^4.3.0
• api-platform/serializer: ^4.3.0
• api-platform/state: ^4.3.0
• api-platform/symfony: ^4.3.0
• api-platform/validator: ^4.3.0
• friendsofcxml/cxml-php: ^2.0.0
• spryker/entity-tag: ^1.0.0
• spryker/glossary-storage: ^1.0.0
• spryker/kernel: ^3.48.0
• spryker/locale: ^4.0.0
• spryker/log: ^3.0.0
• spryker/oauth: ^2.0.0
• spryker/store: ^1.0.0
• spryker/transfer: ^3.27.0
• symfony/config: ^6.0.0 || ^7.0.0
• symfony/console: ^6.0.0 || ^7.0.0
• symfony/expression-language: ^6.0.0 || ^7.0.0
• symfony/finder: ^6.0.0 || ^7.0.0
• symfony/http-kernel: ^6.0.0 || ^7.0.0
• symfony/security-bundle: ^6.0.0 || ^7.0.0
• symfony/yaml: ^6.0.0 || ^7.0.0

Requires (Dev)

• spryker/code-sniffer: *
• spryker/console: *
• spryker/container: *
• spryker/symfony: *
• spryker/testify: *
• symfony/framework-bundle: *

proprietary

• api
• schema
• api-platform
• code-generation
• spryker

README

Installation

composer require spryker/api-platform

Documentation

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.