Skip to content

[Docs] Add "Configure the routes' name" section to resource/configure_your_operations.md #273

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 26, 2025
Merged

[Docs] Add "Configure the routes' name" section to resource/configure_your_operations.md #273

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c75707
[Docs] Add "Configure the routes' name" section to resource/configure…
coldic3 Aug 5, 2025
0fa8ab6
[Docs] Add clear explanation in code example for custom routePrefix i…
coldic3 Aug 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 44 additions & 2 deletions docs/resource/configure_your_operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,7 @@ use Sylius\Resource\Metadata\Update;
#[AsResource(
routePrefix: 'admin',
operations: [
new Index(),
new Index(routePrefix: ''), // you can also customize the route prefix at the operation level too for extra flexibility
new Create(),
new Update(),
new Delete(),
Expand All @@ -463,13 +463,55 @@ class Book implements ResourceInterface

| Name | Method | Path |
|----------------------|-----------------|--------------------------|
| app_book_index | GET | /admin/books/ |
| app_book_index | GET | /books/ |
| app_book_create | GET, POST | /admin/books/new |
| app_book_update | GET, PUT, PATCH | /admin/books/{id}/edit |
| app_book_delete | DELETE | /admin/books/{id} |
| app_book_bulk_delete | DELETE | /admin/books/bulk_delete |
| app_book_show | GET | /admin/books/{id} |

### Configure the routes' name

It customizes the route name for individual operations.

{% code title="src/Entity/Book.php" lineNumbers="true" %}
```php
namespace App\Entity;

use Sylius\Resource\Model\ResourceInterface;
use Sylius\Resource\Metadata\AsResource;
use Sylius\Resource\Metadata\BulkDelete;
use Sylius\Resource\Metadata\Create;
use Sylius\Resource\Metadata\Delete;
use Sylius\Resource\Metadata\Index;
use Sylius\Resource\Metadata\Show;
use Sylius\Resource\Metadata\Update;

#[AsResource(
operations: [
new Index(routeName: 'library_book_list'),
new Create(routeName: 'library_book_add'),
new Update(),
new Delete(),
new BulkDelete(),
new Show(),
],
)
class Book implements ResourceInterface
{
}
```
{% endcode %}

| Name | Method | Path |
|----------------------|-----------------|--------------------------|
| library_book_list | GET | /books/ |
| library_book_add | GET, POST | /books/new |
| app_book_update | GET, PUT, PATCH | /books/{id}/edit |
| app_book_delete | DELETE | /books/{id} |
| app_book_bulk_delete | DELETE | /books/bulk_delete |
| app_book_show | GET | /books/{id} |

### Configure the section

It changes the route name for each operation.
Expand Down