v3.0 Operation Path Naming

Operation Path Naming

With API Platform Core, you can configure the default resolver used to generate operation paths. Pre-registered resolvers are available and can easily be overridden.


There are two pre-registered operation path naming services:

Service nameEntity namePath result

The default resolver is api_platform.path_segment_name_generator.underscore. To change it to the dash resolver, add the following lines to api/config/packages/api_platform.yaml:

# api/config/packages/api_platform.yaml
    path_segment_name_generator: api_platform.path_segment_name_generator.dash

Create a Custom Operation Path Resolver

Let’s assume we need URLs without separators (e.g. api.tld/myresources)

Defining the Operation Segment Name Generator

Make sure the custom segment generator implements ApiPlatform\Operation\PathSegmentNameGeneratorInterface:

// api/src/Operation/SingularPathSegmentNameGenerator.php
namespace App\Operation;

use ApiPlatform\Operation\PathSegmentNameGeneratorInterface;

class SingularPathSegmentNameGenerator implements PathSegmentNameGeneratorInterface
     * Transforms a given string to a valid path name which can be pluralized (eg. for collections).
     * @param string $name usually a ResourceMetadata shortname
     * @return string A string that is a part of the route name
    public function getSegmentName(string $name, bool $collection = true): string
        $name = $this->dashize($name);

        return $name;

    private function dashize(string $string): string
        return strtolower(preg_replace('~(?<=\\w)([A-Z])~', '-$1', $string));

Note that $name contains a camel case string, by default the resource class name (e.g. MyResource).

Registering the Service

If you haven’t disabled the autowiring option, the service will be registered automatically and you have nothing more to do. Otherwise, you must register this class as a service like in the following example:

# api/config/services.yaml
    # ...
    'App\Operation\SingularPathSegmentNameGenerator': ~

Configuring It

# api/config/packages/api_platform.yaml
    path_segment_name_generator: 'App\Operation\SingularPathSegmentNameGenerator'

You can also help us improve the documentation of this page.

Made with love by

Les-Tilleuls.coop can help you design and develop your APIs and web projects, and train your teams in API Platform, Symfony, Next.js, Kubernetes and a wide range of other technologies.

Learn more

Copyright © 2023 Kévin Dunglas

Sponsored by Les-Tilleuls.coop