The Release Process
API Platform follows the Semantic Versioning strategy.
Only 3 versions are maintained at the same time:
- stable (currently the 2.5 branch): regular bug fixes are integrated in this version
- old-stable (currently 2.4 branch): security fixes are integrated in this version, regular bug fixes are not backported in it
- development (master branch): new features target this branch
Older versions (1.x, 2.0...) are not maintained. If you still use them, you must upgrade as soon as possible.
The old-stable branch is merged in the stable branch on a regular basis to propagate security fixes. The stable branch is merged in the development branch on a regular basis to propagate security and regular bug fixes.
New versions of API Platform are released when they are ready, on the behalf of the API Platform Core Team.
The Distribution: Create Powerful APIs with Ease
The API Component
- General Design Considerations
- GraphQL Support
- Enabling GraphQL
- Changing Location of the GraphQL Endpoint
- GraphiQL
- GraphQL Playground
- Modifying or Disabling the Default IDE
- Request with application/graphql Content-Type
- Queries
- Mutations
- Operations
- Workflow of the Resolvers
- Events
- Filters
- Pagination
- Security
- Serialization Groups
- Name Conversion
- Custom Types
- Modify the Extracted Types
- Changing the Serialization Context Dynamically
- Export the Schema in SDL
- Handling File Upload
- Filters
- Doctrine ORM and MongoDB ODM Filters
- Elasticsearch Filters
- Serializer Filters
- Creating Custom Filters
- ApiFilter Annotation
- The Serialization Process
- Overall Process
- Available Serializers
- The Serialization Context, Groups and Relations
- Using Serialization Groups
- Using Serialization Groups per Operation
- Embedding Relations
- Calculated Field
- Changing the Serialization Context Dynamically
- Changing the Serialization Context on a Per-item Basis
- Name Conversion
- Decorating a Serializer and Adding Extra Data
- Entity Identifier Case
- Embedding the JSON-LD Context
- Collection Relation
- Overriding Default Order
- OpenAPI Specification Support (formerly Swagger)
- Pushing Related Resources Using HTTP/2
- Using External Vocabularies
- NelmioApiDocBundle Integration
- Configuration
The Schema Generator Component
- Configuration
- Customizing PHP Namespaces
- Forcing a Field Range
- Forcing a Field Cardinality
- Forcing a Relation Table Name
- Forcing (or Disabling) a Class Parent
- Forcing a Class to be Abstract
- Forcing a Nullable Property
- Forcing a Unique Property
- Making a Property Read-Only
- Making a Property Write-Only
- Forcing a Property to be in a Serialization Group
- Forcing an Embeddable Class to be Embedded
- Author PHPDoc
- Disabling Generators and Creating Custom Ones
- Skipping Accessor Method Generation
- Disabling the id Generator
- Generating UUIDs
- User submitted UUIDs
- Generating Custom IDs
- Disabling Usage of Doctrine Collections
- Changing the Field Visibility
- Generating @Assert\Type Annotations
- Forcing Doctrine Inheritance Mapping Annotation
- Interfaces and Doctrine Resolve Target Entity Listener
- Custom Schemas
- Checking GoodRelation Compatibility
- PHP File Header
- Full Configuration Reference
The Admin Component
The Client Generator Component
Deployment
General Information