The conference dedicated to API Platform and its ecosystem
Overriding Default Order
API Platform Core provides an easy way to override the default order of items in your collection.
By default, items in the collection are ordered in ascending (ASC) order by their resource identifier(s). If you want to
customize this order, you must add an order
attribute on your ApiResource annotation:
<?php
// api/src/Entity/Book.php
namespace App\Entity;
use ApiPlatform\Core\Annotation\ApiResource;
#[ApiResource(order: ["foo" => "ASC"])]
class Book
{
// ...
/**
* ...
*/
public $foo;
// ...
}
# api/config/api_platform/resources/Book.yaml
App\Entity\Book:
attributes:
order:
foo: ASC
This order
attribute is used as an array: the key defines the order field, the values defines the direction.
If you only specify the key, ASC
direction will be used as default. For example, to order by foo
& bar
:
<?php
// api/src/Entity/Book.php
namespace App\Entity;
use ApiPlatform\Core\Annotation\ApiResource;
#[ApiResource(order: ["foo", "bar"])]
class Book
{
// ...
/**
* ...
*/
public $foo;
/**
* ...
*/
public $bar;
// ...
}
# api/config/api_platform/resources/Book.yaml
App\Entity\Book:
attributes:
order: ['foo', 'bar']
It's also possible to configure the default order on an association property:
<?php
// api/src/Entity/Book.php
namespace App\Entity;
use ApiPlatform\Core\Annotation\ApiResource;
#[ApiResource(order: ["author.username"])]
class Book
{
// ...
/**
* @var User
*/
public $author;
// ...
}
# api/config/api_platform/resources/Book.yaml
App\Entity\Book:
attributes:
order: ['author.username']
Another possibility is to apply the default order for a specific collection operation, which will override the global default order configuration.
#[ApiResource(
collectionOperations: [
"get",
"get_desc_custom" => [
"method" => "GET",
"path" => "custom_collection_desc_foos",
"order" => ["name" => "DESC"]
],
"get_asc_custom" => [
"method" => "GET",
"path" => "custom_collection_asc_foos",
"order" => ["name" => "ASC"]
],
]
)]
class Book
{
// ...
/**
* @var string
*/
public $name;
// ...
}
# api/config/api_platform/resources/Book.yaml
App\Entity\Book:
get: ~
get_desc_custom:
method: get
path: custom_collection_desc_foos
order:
name: DESC
get_asc_custom:
method: get
path: custom_collection_asc_foos
order:
name: ASC
What' new?

Sep 15,16 2022: new edition of our conference dedicated to API Platform and its ecosystem!
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
- Operations
- Queries
- Mutations
- Subscriptions
- Workflow of the Resolvers
- Events
- Filters
- Pagination
- Security
- Serialization Groups
- Exception and Error
- Name Conversion
- Custom Types
- Modify the Extracted Types
- Changing the Serialization Context Dynamically
- Export the Schema in SDL
- Handling File Upload
- Change Default Descriptions
- Filters
- Doctrine ORM and MongoDB ODM Filters
- Elasticsearch Filters
- Serializer Filters
- Creating Custom Filters
- ApiFilter Attribute
- The Serialization Process
- Overall Process
- Available Serializers
- The Serialization Context, Groups and Relations
- Using Serialization Groups
- Using Serialization Groups per Operation
- Embedding Relations
- Property Normalization Context
- 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
- Validation
- Validating Submitted Data
- Using Validation Groups
- Using Validation Groups on Operations
- Dynamic Validation Groups
- Sequential Validation Groups
- Validating Delete Operations
- Error Levels and Payload Serialization
- Validation on Collection Relations
- Open Vocabulary Generated from Validation Metadata
- Specification property restrictions
- Overriding Default Order
- OpenAPI Specification Support (formerly Swagger)
- Using the OpenAPI Command
- Overriding the OpenAPI Specification
- Using the OpenAPI and Swagger Contexts
- Changing the Name of a Definition
- Changing Operations in the OpenAPI Documentation
- Changing the Location of Swagger UI
- Using a custom Asset Package in Swagger UI
- Overriding the UI Template
- Compatibility Layer with Amazon API Gateway
- OAuth
- Info Object
- Pushing Related Resources Using HTTP/2
- Using External Vocabularies
- URL Generation Strategy
- NelmioApiDocBundle Integration
- Bootstraping the core library
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
- Define Operations
- 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