The international conference on the API Platform Framework
API Platform Conference 2024: meet the best PHP, JavaScript and API experts
Learn more about the event, register for the conference, and get ready for two days of inspiration, ideas, and knowledge-sharing with our incredible lineup of renowned specialists and advocates.
Register now# 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(attributes={"order"={"foo": "ASC"}})
*/
class Book
{
// ...
/**
* ...
*/
public $foo;
// ...
}
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(attributes={"order"={"foo", "bar"}})
*/
class Book
{
// ...
/**
* ...
*/
public $foo;
/**
* ...
*/
public $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(attributes={"order"={"author.username"}})
*/
class Book
{
// ...
/**
* @var User
*/
public $author;
// ...
}
You can also help us improve the documentation of this page.
