The conference dedicated to API Platform and its ecosystem
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.
Configuration
There are two pre-registered operation path naming services:
Service name | Entity name | Path result |
---|---|---|
api_platform.path_segment_name_generator.underscore |
MyResource |
/my_resources |
api_platform.path_segment_name_generator.dash |
MyResource |
/my-resources |
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
api_platform:
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
:
<?php
// 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
services:
# ...
'App\Operation\SingularPathSegmentNameGenerator': ~
Configuring It
# api/config/packages/api_platform.yaml
api_platform:
path_segment_name_generator: 'App\Operation\SingularPathSegmentNameGenerator'
What' new?

Sep 21,22 2023: new edition of our conference dedicated to API Platform and its ecosystem!
The Distribution: Create Powerful APIs with Ease
Core
- 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
- State Providers
- 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
- Collecting Denormalization Errors
- Overriding Default Order
- OpenAPI Specification Support (formerly Swagger)
- Using the OpenAPI Command
- Overriding the OpenAPI Specification
- Using the OpenAPI and Swagger Contexts
- Disabling an Operation From OpenAPI Documentation
- Changing the Name of a Definition
- Changing Operations in the OpenAPI Documentation
- Disabling Swagger UI or ReDoc
- 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
Schema Generator
- Configuration
- Customizing PHP Namespaces
- Forcing a Field Type (Range)
- Forcing a Field Cardinality
- Changing the Default Cardinality
- Adding a Custom Attribute or Modifying a Generated Attribute
- Forcing (or Enabling) a Class Parent
- Forcing a Class to be Abstract
- Define API Platform Operations
- Forcing a Nullable Property
- Forcing a Unique Property
- Making a Property Read-Only
- Making a Property Write-Only
- Forcing an Embeddable Class to be Embedded
- Skipping Accessor Method Generation
- Using Fluent Mutator Methods
- Disabling the id Generator
- Generating UUIDs
- User-submitted UUIDs
- Generating Custom IDs
- Disabling Usage of Doctrine Collections
- Changing the Field Visibility
- Generating Assert\Type Attributes
- Forcing Doctrine Inheritance Mapping Attribute
- Interfaces and Doctrine Resolve Target Entity Listener
- Custom Schemas
- All Types, Resolve Types and Exclude
- Checking GoodRelation Compatibility
- Author PHPDoc
- PHP File Header
- Disabling Generators and Creating Custom Ones
- Full Configuration Reference