The Distribution: Create Powerful APIs with Ease
Core
- The API Platform Core Library
- Getting started
- Upgrade Guide
- General Design Considerations
- Extending API Platform
- Testing Utilities
- Operations
- GraphQL Support
- State Providers
- State Processors
- Filters
- Subresources
- The Serialization Process
- Validation
- Security
- Content Negotiation
- Pagination
- Deprecating Resources and Properties (Alternative to Versioning)
- Overriding Default Order
- Performance and Cache
- Extensions
- Symfony Messenger Integration: CQRS and Async Message Processing
- Using Data Transfer Objects (DTOs)
- OpenAPI Specification Support (formerly Swagger)
- JSON Schema Support
- Creating Async APIs using the Mercure Protocol
- Pushing Related Resources Using HTTP/2
- Errors Handling
- Using External Vocabularies
- Operation Path Naming
- URL Generation Strategy
- Extending JSON-LD AND Hydra Contexts
- Identifiers
- MongoDB Support
- Elasticsearch Support
- Creating Custom Operations and Controllers
- The Event System
- Handling File Upload
- JWT Authentication
- User Entity
- Accept `application/x-www-form-urlencoded` Form Data
- AngularJS Integration
- FOSUserBundle Integration
- NelmioApiDocBundle Integration
- Bootstraping the core library
- Configuration
- Migrate From FOSRestBundle
- How to create a Guide
- Declare a Resource
- Provide the Resource State
- Hook a Persistence Layer with a Processor
- Doctrine entity as API resource
- Validate incoming data
- Doctrine ORM SearchFilter
- Test your API
- Declare a subresource
- Create a Custom Doctrine Filter
- Extend OpenAPI Documentation
- How to return an IRI instead of an object for your resources relations ?
- Custom pagination
- Handle doctrine links
- Delete operation with validation
Schema Generator
Admin
Create Client
Deployment
General Information
Deploying API Platform Applications
API Platform apps are super easy to deploy in production thanks to the Docker Compose definition and to the Kubernetes chart we provide.
We strongly recommend using Kubernetes or Docker Compose to deploy your apps.
If you want to play with a local Kubernetes cluster, read how to deploy an API Platform project on Minikube.
If you don’t want to use Docker, keep in mind that the server application of API Platform is a standard Symfony project, while the Progressive Web Application is a standard Next.js project:
Watch the Animated Deployment with Ansistrano screencast
Alternatively, you may want to deploy API Platform on a PaaS (Platform as a Service):
You can also help us improve the documentation of this page.
